ScubaTribe API Documentation

POST Signup

Sign up a new user. Only available to partner & publisher api keys

Request Parameters

Parameter Description  

first_name * (string)

last_name * (string)

company_name * (string)

telephone_number * (string)

email_address * (string)

* denotes a required field

After a successfull signup the customer will be sent a welcome email, which will include instructions on setting their password, and choosing the tarif they will start on after their trial has expired.

Possible errors:
Code Field Message
111 first_name empty Field is empty
121 last_name empty Field is empty
122 last_name too_short Field is less 3 than characters
131 company_name empty Field is empty
132 company_name too_short Field is less 4 than characters
141 telephone_number empty Field is empty
151 email_address empty Field is empty
152 email_address invalid Address appears invalid
153 email_address exists An account with this email address already exists

Response

Parameter Description

user_id (int)

The user Id for this account

*on success

api_key (string)

A generated API key for the account.You need this to access the account specific actions for this user account

*on success

status (string)

Was this a successful request?

OK or error

error (array)

A list of errors

*on error
* denotes a response field which is not always present

Example JSON response:

On Success:

{
    "user_id": 814,
    "api_key": "HBDsaXuzE3kj0IMLTfsds4r7nwNGt",
    "status": "OK"
}

On Error:

{
    "status": "error",
    "error": [
        {
            "code": 141,
            "field": "email_address",
            "msg": "invalid"
        },
        {
            "code": 111,
            "field": "first_name",
            "msg": "empty"
        },
        {
            "code": 121,
            "field": "last_name",
            "msg": "empty"
        },
        {
            "code": 131,
            "field": "company_name",
            "msg": "empty"
        }
    ]
}

 

Back to Top