Customers

Create a Customer

Creates a new Customer.

post/admin/customers/customer

Request

Base URL: https://demo.splynx.com/api/2.0
URL: https://demo.splynx.com/api/2.0/admin/customers/customer
Auth: HTTP basic

Request body

loginstring

statusstring

Status: 'new', 'active', 'blocked', 'disabled'. Default value: 'new'

partner_idnumber required

Partner id. You can get it at page "Administration / Partners"

location_idnumber required

Location id. You can get it at page "Administration / Locations"

parent_idnumber

ID of the main (parent) account.

namestring required

Full name

emailstring

billing_emailstring

Billing email

phonestring

Phone number

categorystring required

Category: 'person' (for private person) or 'company' (for company). Default value: 'person'

street_1string

Address part #1

zip_codestring

Zip

citystring

City

date_addstring

Date of adding. Format: 'YYYY-MM-DD'. Default value: current date

customer_labelsnumber[]

Array of customer labels (ids)

subdivision_idnumber

State/province ID

conversion_datestring

Date conversion customer.

daily_prepaid_costnumber

Cost of daily prepayment.

Example request

{
  "login": "john_doe",
  "status": "new",
  "partner_id": 1,
  "location_id": 1,
  "name": "John Doe",
  "email": "john.doe@domain.com",
  "billing_email": "john.doe.billing@domain.com",
  "phone": "555-0134",
  "category": "person",
  "street_1": "Paper Street",
  "subdivision_id": 1,
  "contacts": [
    {
      "id": 1,
      "type": "email",
      "value": "john.doe@domain.com",
      "label": "primary",
      "country_code": "380",
      "is_primary": true
    }
  ]
}

Response

idnumber required

Customer ID

Example response

{
  "id": 1
}

Changes

No recorded changes to this operation across all 1 revision of this API.