Lipisha REST APIs


Update Role


API Description

This API call updates a role.

API Endpoint

The API service endpoint for making the Update Role API call is:

http://developer.lipisha.com/index.php/v2/api/update_role

API Request

The API request is made via HTTP POST and must be url encoded. Some of the parameters are required while others are optional. The parameters are:

Parameter Description Example
api_key Unique string specifying merchant's Lipisha API key.

This should match the api key that you have generated for your Lipisha account
3aa67677e8bf1d4c8fe886a38c03a860
api_signature Unique string specifying merchant's Lipisha API signature.

This should match the api signature that you have generated for your Lipisha account
SYetmwsNnb5bwaZRyeQ..........KhZNNkCoEx+5x=
api_version String specifying the version of the API in use 1.3.0
api_type String specifying the type of handshake or IPN call Callback
role String specifying the name of the role Accountant
role_description String specifying the description of the role Only allowed to carry out aaccounting functions.
view_dashboard Integer specifying whether permission has been granted or not.
0 for no, 1 for yes
0
view_balance Integer specifying whether permission has been granted or not.
0 for no, 1 for yes
0
make_bulk_payments Integer specifying whether permission has been granted or not.
0 for no, 1 for yes
0
mobile_money Integer specifying whether permission has been granted or not.
0 for no, 1 for yes
0
view_transactions Integer specifying whether permission has been granted or not.
0 for no, 1 for yes
0
view_audit_logs Integer specifying whether permission has been granted or not.
0 for no, 1 for yes
0
credit_card Integer specifying whether permission has been granted or not.
0 for no, 1 for yes
1
airtime Integer specifying whether permission has been granted or not.
0 for no, 1 for yes
1
request_settlement Integer specifying whether permission has been granted or not.
0 for no, 1 for yes
1
authorize_settlement Integer specifying whether permission has been granted or not.
0 for no, 1 for yes
1
view_customers Integer specifying whether permission has been granted or not.
0 for no, 1 for yes
1
run_sms_campaign Integer specifying whether permission has been granted or not.
0 for no, 1 for yes
1
view_past_campaigns Integer specifying whether permission has been granted or not.
0 for no, 1 for yes
1
email_campaign Integer specifying whether permission has been granted or not.
0 for no, 1 for yes
1
manage_roles Integer specifying whether permission has been granted or not.
0 for no, 1 for yes
1
manage_users Integer specifying whether permission has been granted or not.
0 for no, 1 for yes
1
manage_payments Integer specifying whether permission has been granted or not.
0 for no, 1 for yes
1
change_password Integer specifying whether permission has been granted or not.
0 for no, 1 for yes
1
manage_api Integer specifying whether permission has been granted or not.
0 for no, 1 for yes
1
update_account Integer specifying whether permission has been granted or not.
0 for no, 1 for yes
1
manage_settlements Integer specifying whether permission has been granted or not.
0 for no, 1 for yes
1
send_airtime Integer specifying whether permission has been granted or not.
0 for no, 1 for yes
1
manage_airtime_accounts Integer specifying whether permission has been granted or not.
0 for no, 1 for yes
1

API Response

The API reponse will be returned as JSON. Each response will contain a status and content section. The parameters are:

Parameter Description Example
Status
status String specifying whether API Call executed successfully or failed SUCCESS
status_code Integers specifying status code of the API Call result 0000
status_description String containing description of the status Role updated
Content
role String specifying the name of the role Accountant
role_description String specifying the description of the role Only allowed to carry out aaccounting functions.
view_dashboard Integer specifying whether permission has been granted or not.
0 for no, 1 for yes
0
view_balance Integer specifying whether permission has been granted or not.
0 for no, 1 for yes
0
make_bulk_payments Integer specifying whether permission has been granted or not.
0 for no, 1 for yes
0
mobile_money Integer specifying whether permission has been granted or not.
0 for no, 1 for yes
0
view_transactions Integer specifying whether permission has been granted or not.
0 for no, 1 for yes
0
view_audit_logs Integer specifying whether permission has been granted or not.
0 for no, 1 for yes
0
credit_card Integer specifying whether permission has been granted or not.
0 for no, 1 for yes
1
airtime Integer specifying whether permission has been granted or not.
0 for no, 1 for yes
1
request_settlement Integer specifying whether permission has been granted or not.
0 for no, 1 for yes
1
authorize_settlement Integer specifying whether permission has been granted or not.
0 for no, 1 for yes
1
view_customers Integer specifying whether permission has been granted or not.
0 for no, 1 for yes
1
run_sms_campaign Integer specifying whether permission has been granted or not.
0 for no, 1 for yes
1
view_past_campaigns Integer specifying whether permission has been granted or not.
0 for no, 1 for yes
1
email_campaign Integer specifying whether permission has been granted or not.
0 for no, 1 for yes
1
manage_roles Integer specifying whether permission has been granted or not.
0 for no, 1 for yes
1
manage_users Integer specifying whether permission has been granted or not.
0 for no, 1 for yes
1
manage_payments Integer specifying whether permission has been granted or not.
0 for no, 1 for yes
1
change_password Integer specifying whether permission has been granted or not.
0 for no, 1 for yes
1
manage_api Integer specifying whether permission has been granted or not.
0 for no, 1 for yes
1
update_account Integer specifying whether permission has been granted or not.
0 for no, 1 for yes
1
manage_settlements Integer specifying whether permission has been granted or not.
0 for no, 1 for yes
1
send_airtime Integer specifying whether permission has been granted or not.
0 for no, 1 for yes
1
manage_airtime_accounts Integer specifying whether permission has been granted or not.
0 for no, 1 for yes
1

JSON Reponse
{
  "status": {
    "status_code": "0000",
    "status_description": "Role updated",
    "status": "SUCCESS"
  },
  "content": {
    "role": "Accountant",
    "role_description": "Only allowed to carry out aaccounting functions.",
    "view_dashboard": "0",
    "view_balance": "0",
    "make_bulk_payments": "0",
    "mobile_money": "0",
    "view_transactions": "0",
    "view_audit_logs": "0",
    "credit_card": "1",
    "airtime": "1",
    "request_settlement": "1",
    "authorize_settlement": "1",
    "view_customers": "1",
    "run_sms_campaign": "1",
    "view_past_campaigns": "1",
    "email_campaign": "1",
    "manage_roles": "1",
    "manage_users": "1",
    "manage_payments": "1",
    "change_password": "1",
    "manage_api": "1",
    "update_account": "1",
    "manage_settlements": "1",
    "send_airtime": "1",
    "manage_airtime_accounts": "1"
  }
}

Fork me on GitHub