Carbon

Customer Contact

The customer contact resource.

Basehttps://rest.carbon.ms/customerContact
GET/customerContact

List customer contacts

Retrieve a paginated list of customer contacts. Filter, order, and select columns with PostgREST query parameters.

Query parameters

selectstring

Comma-separated columns to return. Defaults to all.

orderstring

Column to sort by, e.g. `createdAt.desc`.

limitinteger

Maximum rows to return.

offsetinteger

Rows to skip, for pagination.

GEThttps://rest.carbon.ms/customerContact
curl --request GET \
  --url 'https://rest.carbon.ms/customerContact?select=*&limit=10' \
  --header 'Authorization: Bearer <api-key>'
Response
[
  {
    "id": "abc123def456",
    "customerId": "xyz789",
    "contactId": "xyz789",
    "customerLocationId": "xyz789",
    "userId": "xyz789",
    "customFields": "string",
    "tags": []
  }
]
GET/customerContact

Retrieve a customer contact

Fetch a single customer contact by filtering on `id`.

Query parameters

idstring

Match on the customer contact's `id`, e.g. `eq.{id}`.

GEThttps://rest.carbon.ms/customerContact
curl --request GET \
  --url 'https://rest.carbon.ms/customerContact?id=eq.%7Bid%7D' \
  --header 'Authorization: Bearer <api-key>'
Response
{
  "id": "abc123def456",
  "customerId": "xyz789",
  "contactId": "xyz789",
  "customerLocationId": "xyz789",
  "userId": "xyz789",
  "customFields": "string",
  "tags": []
}
POST/customerContact

Create a customer contact

Create a new customer contact.

Body parameters

customerIdstringrequired

References customer.id

contactIdstringrequired

References contact.id

customerLocationIdstring

References customerLocation.id

userIdstring

References user.id

customFieldsobject
tagsarray
POSThttps://rest.carbon.ms/customerContact
curl --request POST \
  --url https://rest.carbon.ms/customerContact \
  --header 'Authorization: Bearer <api-key>' \
  --header 'Content-Type: application/json' \
  --header 'Prefer: return=representation' \
  --data '{"customerId":"xyz789","contactId":"xyz789"}'
Response
{
  "id": "abc123def456",
  "customerId": "xyz789",
  "contactId": "xyz789",
  "customerLocationId": "xyz789",
  "userId": "xyz789",
  "customFields": "string",
  "tags": []
}
PATCH/customerContact

Update a customer contact

Update an existing customer contact, matched on `id`.

Body parameters

customerIdstringrequired

References customer.id

contactIdstringrequired

References contact.id

customerLocationIdstring

References customerLocation.id

userIdstring

References user.id

customFieldsobject
tagsarray
PATCHhttps://rest.carbon.ms/customerContact
curl --request PATCH \
  --url 'https://rest.carbon.ms/customerContact?id=eq.%7Bid%7D' \
  --header 'Authorization: Bearer <api-key>' \
  --header 'Content-Type: application/json' \
  --header 'Prefer: return=representation' \
  --data '{"customerId":"xyz789"}'
Response
{
  "id": "abc123def456",
  "customerId": "xyz789",
  "contactId": "xyz789",
  "customerLocationId": "xyz789",
  "userId": "xyz789",
  "customFields": "string",
  "tags": []
}
DELETE/customerContact

Delete a customer contact

Delete a customer contact, matched on `id`. Returns 204 No Content.

Query parameters

idstring

The `id` of the customer contact to delete, e.g. `eq.{id}`.

DELETEhttps://rest.carbon.ms/customerContact
curl --request DELETE \
  --url 'https://rest.carbon.ms/customerContact?id=eq.%7Bid%7D' \
  --header 'Authorization: Bearer <api-key>'
204 No Content