Invite Customer/Employee

<< Click to Display Table of Contents >>

Navigation:  Journalytix API >

Invite Customer/Employee

The Invite Customer/Employee API is used to invite existing Journalytix users to participate in your companies' Journalytix. You will be able to see their full history and log on as that user. An email will be sent to the user and he will need to click an approval link before you will see them on your side.


The parameters to send to register a customer are as follows:

Company ID - admin user id of company on the Journalytix system

Company Password - password of the admin user for the company on the Journalytix system

API Code - API code for the company

Employee Email Address - Email address of Employee to Invite

Account Provider ID - Provider ID of the account (e.g CQG, GAIN, IBTWS, JIGSAW_SIM, MT4, MT5, NT8, Rithmic, Tradovate, TTAPI, TTRESTAPI)

Account Name - Account number of the account


Account Provider ID and Account Name are optional.

Account Provider Id and Account Name will only be allowed if the email address already belongs to an existing member/user of Journalytix. For registering completely new members use Register Customer/Employee.

Note that if user accepts, the user will be either permanently assigned as an employee or for the number of days set in "Default Account Days" in Company Settings.

All inputs are mandatory.


Error Codes

01 - Technical Issue Sending Email, Contact Jigsaw Support

02 - API Code Not Valid

03 - Invalid Company User Name or Password

04 - Not All Properties Have a Value

05 - Account Details not Allowed for Unregistered Emails

06 - Account Does not Belong to This Company


Success Code

  "Email Sent"


Sample PHP Code for Posting to the API is here



You can test adding a customer via the API here: