Customers

Create customer

Add new customer

post/customers

Request

Base URL
https://api.vrio.app
URL
https://api.vrio.app/customers
Auth
API key in header X-Api-Key

Request body

connection_idinteger required

first_namestring required

First name for customer.

last_namestring required

Last name for customer.

emailstring required

Email address of the customer. This is what creates a unique customer ID.

phonestring

Telephone number of the customer.

birthdaystring date

Customer birthdate. YYYY-MM-DD

genderstring

Customer gender.

pronoun_idnull | 1 | 2 | 3 | 4 nullable

1 - he/him
2 - she/her
3 - they/them
4 - rather not say

is_blacklistboolean

Should the customer be blacklisted.

is_fraudboolean

Should the customer be flagged as fraud.

tracking1string

Custom Tracking Variable Option 1 for the customer

tracking2string

Custom Tracking Variable Option 2 for the customer

tracking3string

Custom Tracking Variable Option 3 for the customer

tracking4string

Custom Tracking Variable Option 4 for the customer

tracking5string

Custom Tracking Variable Option 5 for the customer

tracking6string

Custom Tracking Variable Option 6 for the customer

tracking7string

Custom Tracking Variable Option 7 for the customer

tracking8string

Custom Tracking Variable Option 8 for the customer

tracking9string

Custom Tracking Variable Option 9 for the customer

tracking10string

Custom Tracking Variable Option 10 for the customer

tracking11string

Custom Tracking Variable Option 11 for the customer

tracking12string

Custom Tracking Variable Option 12 for the customer

tracking13string

Custom Tracking Variable Option 13 for the customer

tracking14string

Custom Tracking Variable Option 14 for the customer

tracking15string

Custom Tracking Variable Option 15 for the customer

tracking16string

Custom Tracking Variable Option 16 for the customer

tracking17string

Custom Tracking Variable Option 17 for the customer

tracking18string

Custom Tracking Variable Option 18 for the customer

tracking19string

Custom Tracking Variable Option 19 for the customer

tracking20string

Custom Tracking Variable Option 20 for the customer

Response

customer_idinteger

connection_customer_idstring nullable

connection_idinteger

first_namestring

last_namestring

emailstring

ip_addressstring

phonestring

birthdaystring date nullable

genderstring

pronoun_idnull | 1 | 2 | 3 | 4 nullable

1 - he/him
2 - she/her
3 - they/them
4 - rather not say

active_subscriberboolean

is_blacklistboolean

is_fraudboolean

date_createdstring date-time

date_modifiedstring date-time

created_byinteger

modified_byinteger

customer_notesstring nullable

tracking1string nullable

tracking2string nullable

tracking3string nullable

tracking4string nullable

tracking5string nullable

tracking6string nullable

tracking7string nullable

tracking8string nullable

tracking9string nullable

tracking10string nullable

tracking11string nullable

tracking12string nullable

tracking13string nullable

tracking14string nullable

tracking15string nullable

tracking16string nullable

tracking17string nullable

tracking18string nullable

tracking19string nullable

tracking20string nullable

Example response

{
  "date_created": "2023-04-01 00:00:00",
  "date_modified": "2023-04-01 00:00:00",
  "customer_cards": [
    {
      "date_created": "2023-04-01 00:00:00",
      "date_modified": "2023-04-01 00:00:00"
    }
  ],
  "customer_addresses": [
    {
      "date_created": "2023-04-01 00:00:00",
      "date_modified": "2023-04-01 00:00:00"
    }
  ]
}

Changes

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