POST Customers

Create new customer record or Update Existing record. If Updating existing record, pass valid PersonalId If Creating new record, pass the Unique PersonalId

Request Information

URI Parameters

None.

Body Parameters

Customer record

Customer

Name	Description	Type	Additional information
CustomerId	QFlow Customer Id	integer	None.
PersonalId	Vendor's Customer identifier	string	Max length: 30
PersonalIdTypeId	Vendor's Customer identifier Type (QFlow CustomerIdTypeId). 0 =none, null=first available	integer	None.
PersonalIdTypeExtRef		string	None.
FirstName	First Name	string	Max length: 50
LastName	Last Name	string	Max length: 50
Email	Email address	string	Max length: 100
TelNumber1	Phone Number 1	string	Max length: 25
TelNumber2	Phone Number 2	string	Max length: 25
DOB	Date of Birth	date	None.
Sex	0=Unknown; 1=Male; 2=Female	byte	Range: inclusive between 0 and 2
Notes	Notes	string	Max length: 250
ExtRef	Custom External Reference	string	Max length: 200
NotificationConsent		boolean	None.
IsActive	Is customer record enabled	boolean	None.
CustomProperties	Collection of all custom properties for this customer	Dictionary of string [key] and string [value]	None.

Request Formats

application/json, text/json

Sample:

{
  "CustomerId": 1,
  "PersonalId": "sample string 2",
  "PersonalIdTypeId": 1,
  "PersonalIdTypeExtRef": "sample string 3",
  "FirstName": "sample string 4",
  "LastName": "sample string 5",
  "Email": "sample string 6",
  "TelNumber1": "sample string 7",
  "TelNumber2": "sample string 8",
  "DOB": "2025-06-27T08:08:43.3324837+10:00",
  "Sex": 64,
  "Notes": "sample string 9",
  "ExtRef": "sample string 10",
  "NotificationConsent": true,
  "IsActive": true,
  "CustomProperties": {
    "sample string 1": "sample string 2",
    "sample string 3": "sample string 4"
  }
}

application/x-www-form-urlencoded

Sample:

Sample not available.

Response Information

Resource Description

Customer Record with CustomerId updated if creating

Customer

Name	Description	Type	Additional information
CustomerId	QFlow Customer Id	integer	None.
PersonalId	Vendor's Customer identifier	string	Max length: 30
PersonalIdTypeId	Vendor's Customer identifier Type (QFlow CustomerIdTypeId). 0 =none, null=first available	integer	None.
PersonalIdTypeExtRef		string	None.
FirstName	First Name	string	Max length: 50
LastName	Last Name	string	Max length: 50
Email	Email address	string	Max length: 100
TelNumber1	Phone Number 1	string	Max length: 25
TelNumber2	Phone Number 2	string	Max length: 25
DOB	Date of Birth	date	None.
Sex	0=Unknown; 1=Male; 2=Female	byte	Range: inclusive between 0 and 2
Notes	Notes	string	Max length: 250
ExtRef	Custom External Reference	string	Max length: 200
NotificationConsent		boolean	None.
IsActive	Is customer record enabled	boolean	None.
CustomProperties	Collection of all custom properties for this customer	Dictionary of string [key] and string [value]	None.

Response Formats

application/json, text/json

Sample:

{
  "CustomerId": 1,
  "PersonalId": "sample string 2",
  "PersonalIdTypeId": 1,
  "PersonalIdTypeExtRef": "sample string 3",
  "FirstName": "sample string 4",
  "LastName": "sample string 5",
  "Email": "sample string 6",
  "TelNumber1": "sample string 7",
  "TelNumber2": "sample string 8",
  "DOB": "2025-06-27T08:08:43.3324837+10:00",
  "Sex": 64,
  "Notes": "sample string 9",
  "ExtRef": "sample string 10",
  "NotificationConsent": true,
  "IsActive": true,
  "CustomProperties": {
    "sample string 1": "sample string 2",
    "sample string 3": "sample string 4"
  }
}