Create Membership

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

Request

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

Parameters

Name Type Description
networkEID EID Network EID

Request body

Supply a complete membership resource in the request body. Optionally supplemented with a role object (in the case of network memberships). You should omit the since and invitedAt dates as they will be set server-side.

Name Type Description
role object Role
role key string Unique identifier (for built-in roles)
role EID EID Unique entity identifier (for user-defined roles)

Example (network membership)

{
    "rev": "network",
    "role": {
        "key": "admin"
    }
}

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
User already is a member: returns an Error object

See also

Join Group