Campaign Members


Campaign Members

To get a list of all the members of a campaign, use the following endpoint.

Method URI Headers
GET 1.0/campaigns/{id}/users Default

Results

{
    "data": [
        {
            "id": 1,
            "name": "Ilestis",
            "avatar": "{url}"
        },
        {
            "id": 2,
            "name": "Ilestis Jr.",
            "avatar": "{url}"
        }
    ]
}

Campaign Member

To get the info of an specific member of a campaign, use the following endpoint.

Method URI Headers
GET 1.0/campaigns/{id}/users/{user_id} Default

Results

{
    "data": [
        {
            "id": 1,
            "name": "Ilestis",
            "avatar": "{url}"
        }
    ]
}

Add Role To Member

To add a role to a member of the campaign, use the following endpoint.

Method URI Headers
POST 1.0/campaigns/{id}/users Default

Body

Parameter Type Detail
user_id integer (Required) The user's id
role_id integer (Required) The role's id

Results

{
    "data": "role successfully added to user"
}

Remove Role From Member

To remove a role from a member of the campaign, use the following endpoint.

Method URI Headers
DELETE 1.0/campaigns/{id}/users Default

Body

Parameter Type Detail
user_id integer (Required) The user's id
role_id integer (Required) The role's id

Results

{
    "data": "role successfully removed from user"
}