Create Membership

CUSTOM-ENDPOINT

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

CUSTOM-REQUEST

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

Parameters

NameTypeDescription
networkEIDEIDNetwork 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.

NameTypeDescription
roleobjectRole
role.[key]stringUnique identifier (for built-in roles)
role.[EID]EIDUnique entity identifier (for user-defined roles)

Example (network membership)

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

Response

StatusData
202Accepted for insertions: returns a Feedback object
400Invalid data: returns an Error object
403Unauthorized: returns an Error object
404Unknown network: returns an Error object
409User already is a member: returns an Error object