API Member

Compatibility

• EE2
• EE3
• EE4
• EE5
• EE6
• EE7

Installation

1. Copy the files to the system/user dir
2. Enable the API from within the Webservice Module

Methods

create_member

Short name	Description
group_id	The group ID	Required
username		Required
screen_name		Required
password		Required
email		Required
url		Optional
location		Optional
bio		Optional
language		Optional
timezone		Optional
date_format		Optional
time_format		Optional
include_seconds		Optional
bday_y		Optional
bday_m		Optional
bday_d		Optional
occupation		Optional
interests		Optional
aol_im		Optional
icq		Optional
yahoo_im		Optional
msn_im		Optional
custom_fields		Optional

Request

Array
(
    [group_id] => 2
    [username] => test user
    [screen_name] => Test User
    [password] => du*7e2O
    [email] => info@test.com
)

read_member

Short name	Description
member_id	The member ID	Required

Request

Array
(
    [member_id] => 2
)

search_member

Short name	Description
member_id	The member ID	Optional
group_id	The member email	Optional
email	The member email	Optional
screen_name	The member screen_name	Optional
username	The member username	Optional

Request

Array
(
    [email] => 'test@example.com'
)

update_member

Short name	Description
member_id	The member ID	Required
screen_name		Optional
email		Optional
url		Optional
location		Optional
bio		Optional
language		Optional
timezone		Optional
date_format		Optional
time_format		Optional
include_seconds		Optional
bday_y		Optional
bday_m		Optional
bday_d		Optional
occupation		Optional
interests		Optional
aol_im		Optional
icq		Optional
yahoo_im		Optional
msn_im		Optional
custom_fields		Optional

Request

Array
(
    [member_id] => 2
    [msn_im] => jan0292
)

Limitation:

Username update has been disabled due some EE complexity

Notes

Password can be updated with password method, se below

delete_member

Short name	Description
member_id	The member ID	Required

Request

Array
(
    [member_id] => 2
)

update_member_password

Short name	Description
member_id	The member ID	Required
password		Required
repeat_password		Required
verify_password		Required

Request

Array
(
    [member_id] => 2
    [password] => your-new-password
    [repeat_password] => your-new-password
    [verify_password] => your-current-password
)

Hooks

the default EE hooks are being used.