Create user-defined Role (since 1.0.12)

POST https://api.speakap.io/networks/:eid/roles/

Request

URI:/networks/{networkEID}/roles/
Method:POST
Content-Type:application/json
Authentication:OAuth 2.0

Parameters

Name Type Description
networkEID EID Network EID

Request body

Supply a JSON resource consisting of a role name and a set of permissions.

Examples

Note that roleType will always automatically be set to user_defined for roles created via this endpoint.

{
    "name": "HR Manager",
    "permissions": [
        "...",
        "view_group",
        "view_user",
        "view_membership",
        "view_profile",
        "..."
    ]
}

Response

202
Accepted for insertion: returns a Feedback object
400
Invalid data: returns an Error object
403
Unauthorized: returns an Error object
404
Unknown network: returns an Error object
409
Role with the same name exists: returns an Error object