Skip to main content
POST
/
api
/
rest
/
customers
Create One Customer
curl --request POST \
  --url https://api.upwell.com/api/rest/customers \
  --header 'Content-Type: application/json' \
  --data '
{
  "input": {
    "addresses": {},
    "addressesLastUpdatedAt": "2023-11-07T05:31:56Z",
    "billToCustomerId": "<string>",
    "ccEmailAddresses": [
      "<string>"
    ],
    "collectorId": "<string>",
    "contacts": {},
    "contactsLastUpdatedAt": "2023-11-07T05:31:56Z",
    "customerEmailSettings": {},
    "customerIntegrationSettings": {},
    "customerRule": {},
    "deletedAt": "<unknown>",
    "emailAddress": "<string>",
    "metadata": "<unknown>",
    "name": "<string>",
    "paymentLineItems": {},
    "remittanceLineItems": {},
    "sourceSystem": "<string>",
    "sourceSystemId": "<string>"
  }
}
'
{
  "createCustomer": {
    "addresses": [
      {
        "city": "<string>",
        "country": "AD",
        "id": "<string>",
        "stateOrProvince": "<string>",
        "streetLine1": "<string>",
        "streetLine2": "<string>",
        "type": "ADDRESS_BOOK",
        "zipOrPostalCode": "<string>"
      }
    ],
    "balance": 123,
    "billToCustomerId": "<string>",
    "ccEmailAddresses": [
      "<string>"
    ],
    "createdAt": "2023-11-07T05:31:56Z",
    "customerRule": {
      "dueOption": 123,
      "id": "<string>"
    },
    "emailAddress": "<string>",
    "id": "<string>",
    "metadata": "<unknown>",
    "name": "<string>",
    "overdueBalance": 123,
    "overdueInvoiceCount": 123,
    "sourceSystem": "<string>",
    "sourceSystemId": "<string>",
    "updatedAt": "2023-11-07T05:31:56Z"
  }
}

Headers

authorization
string

Your API key will be used for authentication of the request. Authorization: YOUR_API_KEY

Body

application/json

Query parameters can also be provided in the request body as a JSON object

input
CustomersInsertInput Ā· object

input type for inserting data into table "customers"

Response

200 - application/json

Responses for POST /api/rest/customers

createCustomer
Customers Ā· object

columns and relationships of "customers"