Onboard

curl -X PUT -H "Content-Type: application/json" -d '{
    "data": {
        "account": {
            "name": "TESTING4167",
            "timezone": "Pacific/Auckland",
            "language": "en-NZ"
        },
        "billing_contact": {
                "email": "new_email@gmail.com",
                "mobile": "12345678",
                "name": "New Email",
                "phone": "12345678"
        },
        "location": {
        "address_1": "Test Location",
        "address_2": "Test Suburb",
        "city": "Testeville",
        "zip": "1011",
        "name": "Testicules",
        },
        "domain": "wholesale.domain.com",
        "user": {
            "email": "user_email@gmail.com",
            "first_name": "New",
            "last_name": "User",
            "password": "123456789",
            "username": "user_email@gmail.com"
        },
        "braintree": {
            "credit_card": {
                "cardholder_name": "My Card",
                "expiration_month": 12,
                "expiration_year": 2022,
                "number": "4111111111111111",
                "cvv": "123"
        
            }
        }
    }
}' "https://c-api.conversant.co.nz/v1/onboard"

v1/onboard

 

Property
Description
Validation
Modifiable
account The Account Parameters object yes
billing_contact The Billing Contact Parameters object yes
location The Location Parameters object yes
domain The Domain that the account should be created under string yes
user The User Parameters object yes
braintree The Braintree Parameters object yes
code The salesperson identifier that will be assigned to the new account string yes
Verb
Accepted
Returned
Description
PUT ANY ALL Create the account
Property
Description
Validation
Modifiable
name The name of the account  string yes
timezone The default timezone to be used for the account  Unix timezone yes

language The default language to be used for the account   yes
Property
Description
Validation
Modifiable
email The email address of the billing contact Email address yes
mobile The mobile phone number of the billing contact String yes
name The name of the billing contact String yes
phone The phone number of the billing contact String yes

 

 

Property
Description
Validation
Modifiable
address_1 Address line one of the billing address  string yes
address_2 Address line two of the billing address  string yes
city Name of the city of the billing address string yes
zip Postcode of the billing address string yes
name Location name string yes

 

 

Property
Description
Validation
Modifiable
email The email address of the user email yes
first_name The first name of the user string yes
last_name The last name of the user string yes
password The password of the user string yes
username The username of the user string yes

 

 

Property
Description
Validation
Modifiable
credit_card The Credit Card parameters object yes

 

Property
Description
Validation
Modifiable
cardholder_name The name on the credit card string yes
expiration_month A two digit number indicating the expiration month of the credit card integer yes
expiration_year A four digit number indicating the expiration year of the credit card integer yes
number The credit card number integer yes
cvv The CVV number from the back of the card integer yes