ADD USER

POST https://{sub_domain}.izihelp.com/api/people/user

• ADD REQUESTER WITH EMAIL

Required fields: name, email

 {
    "name":"Robo Lee",
    "email":"example@gmail.com",
    "roles":["requester"]
 }

• ADD REQUESTER WITH PHONE NUMBER

Required fields: name, country code, phone number

{
  "name":"Marry",
  "code":84,
  "phone":"0123456789",
  "roles":["requester"]
}

• ADD AGENT

Required info: name, email.

role: admin, supervisor, agent

 {
    "name":"Johnny",
    "email":"example@gmail.com",
    "roles":["agent"]
 }

RETRIEVE USER INFO

GET https://{sub_domain}.izihelp.com/api/people/user/{user_id}

RETRIEVE USER INFORMATION

GET https://{sub_domain}.izihelp.com/api/people/user/{user_id}

UPDATE USER INFORMATION

• Accounts with higher privileges can update accounts with lower privileges, but not vice versa .
• Privilege hierarchy as following : owner > admin > supervisor > agent > requester

PUT https://{sub_domain}.izihelp.com/api/people/user/{user_id}

 
{ "name":"John Doe",
  "roles":["admin"], //upgrade role to admin
  "fields":{ //user custom fields
     "credits":500000, 
     "age":"50", 
     "gender":"male"
  }
}

ADD USER CONTACT

POST https://{sub_domain}.izihelp.com/api/people/user/{user_id}/contacts

• Add additional email

 
{
  "type":1,
  "value":"example@gmail.com"
} 

• Add additional phone number

{ 
 "type":2,
 "code":84, //country code
 "value":"0123456789"
}

• Add additional Facebook profile ID

 
{
 "type":3,
 "value":"1001234567890" 
} 

UPDATE USER CONTACT

PUT https://{sub_domain}.izihelp.com/api/people/user/{user_id}/contacts/{contact_id}

 { "code":84, "value":"0123456789"} 

RETRIEVE USER CONTACT

• Retrieve all contacts

GET https://{sub_domain}.izihelp.com/api/people/user/{user_id}/contacts

• Retrieve all email contacts

GET https://{sub_domain}.izihelp.com/api/people/user/{user_id}/contacts?type=email

• Retrieve all phone contacts

GET https://{sub_domain}.izihelp.com/api/people/user/{user_id}/contacts?type=phone