get /users/me users.me Me
Fetches the current authenticated user
Iris msg API – v1
A set of endpoints to manage Iris msg organisations and sent messages to subscribers through the donor network
Auth
post /users/login/request users.login_request Request login
Requests a login sms to be sent and creates a new user if it doesn't exist
| name | type | description |
|---|---|---|
| phoneNumber | string | The local phone number of the user |
| countryCode | string | The ISO_3166-2 country where the phone is |
post /users/login/check users.login_check Check login
Checks a login sms code and logs in the user and optionally verifies the user
| name | type | description |
|---|---|---|
| code | number | The sms code to check |
post /users/update_fcm users.update_fcm Set fcm token
Updates the fcm token for the current user
| name | type | description |
|---|---|---|
| newToken | string | The updated fcm token |
Organisations
get /organisations/ orgs.index Index
Fetches organisations the current user is part of
get /organisations/:org_id orgs.show Show
Fetches a specific organisation that the user is part of
| name | type | description |
|---|---|---|
| org_id | string | The id of the organisation ti fetch |
get /organisations/:org_id/members orgs.members Members
Fetches the members of an organisation with their phone numbers
| name | type | description |
|---|---|---|
| org_id | string | The id of the organisation ti fetch |
post /organisations/ orgs.create Create
Creates a new organisation with the current user as a coordinator
| name | type | description |
|---|---|---|
| name | string | The name of the new organisation |
| info | string | A longer description of the new organisation |
delete /organisations/:org_id orgs.destroy Destroy
Deletes an organisation (using a soft delete)
| name | type | description |
|---|---|---|
| org_id | string | The id of the delete |
Membership
post /organisations/:org_id/members members.create Create
Invites a member to an organisation
| name | type | description |
|---|---|---|
| org_id | string | The id of the organisation to be added to |
| name | type | description |
|---|---|---|
| phoneNumber | string | The phone number of the person to invite |
| countryCode | string | The ISO_3166-2 country where the phone is |
| role | string | The role of the new user (coordinator|donor|subscriber) |
| label | string | A label for the new member |
delete /organisations/:org_id/members/:mem_id members.destroy Destroy
Remove a member from an organisation (uses a soft delete)
| name | type | description |
|---|---|---|
| org_id | string | The id of the organisation to be removed from |
| mem_id | string | The id of the membership to be removed |
post /accept/:token members.acceptInvite Accept Invite
Accept an invitation to join an organisation and returns UserAuth
| name | type | description |
|---|---|---|
| token | string | The invite token the user was sent |
get /unsub/:token members.unsubscribe Unsubscribe
Unsubscribes a member from an organisation (uses a soft delete)
| name | type | description |
|---|---|---|
| token | string | The unsubscribe token the user was sent |
get /invite/:token members.showInvite Show Invite
Gets the information for a deep-linked donation accept screen
| name | type | description |
|---|---|---|
| token | string | The invite token the user was sent |
Messages
get /messages/ messages.create Create
Creates a message and sends out fcm `new_donations` messages to donors
| name | type | description |
|---|---|---|
| orgId | string | The id of the organisation to send to |
| content | string | The message to be sent |
get /messages/attempts messages.attempts_index Pending Attempts
Gets the pending messages you have to send as a donor
post /messages/attempts messages.attempts_update Update Attempts
Sets the state of a set of MessageAttempts
| name | type | description |
|---|---|---|
| updates | array | The updates to perform |
| updates[n].attempt | string | The id of the attempt to update |
| updates[n].newState | string | The new state of the attempt (success|failed|rejected|no_service|no_sms_data|radio_off) |