member.delete

Description

Delete a single member object.  Please see Deleting Objects for an overview of how the delete method works.

There are special considerations for deleting member objects, please understand them before calling this method.  When a member object is deleted, the username associated with that member is not released.  Therefore, any subsequence member.create for that same username will fail with a duplicate object error.  See member.create.

Parameters

username

A string representing the unique id of the member to delete.  You may also pass a json object with a field of id to identify the member you wish to delete.

Response

Delete returns null on success.

Examples

A Sample JSON-RPC Member Delete Request

{
    "method": "member.delete",
    "params": ["example_username"],
    "id": 1
}

The JSON-RPC Response

{
    "result": true,
    "error": null,
    "id": 1
}

Permissions Required

The user who owns the key used to authenticate the member.delete call must be a member of one of the following roles

• Administrator
• Program Manager
• Community Manager

See authentication.

Errors

In addition to the standard json-rpc errors and authentication errors, member.delete may also return these errors: