Update Team Membership Status

v1.0.0

Use this endpoint to allow a user to accept an invitation to join a team after being redirected back to your app from the invitation email recieved by the user.

Input

{
  "type": "object",
  "properties": {
    "membershipId": {
      "type": "string"
    },
    "secret": {
      "type": "string",
      "description": "Secret key."
    },
    "teamId": {
      "type": "string"
    },
    "userId": {
      "type": "string",
      "description": "User unique ID."
    }
  },
  "required": [
    "membershipId",
    "secret",
    "teamId",
    "userId"
  ],
  "additionalProperties": false
}

Output

{
  "type": "object",
  "description": "Membership",
  "required": [
    "$id",
    "confirm",
    "email",
    "invited",
    "joined",
    "name",
    "roles",
    "teamId",
    "userId"
  ],
  "properties": {
    "$id": {
      "type": "string",
      "description": "Membership ID."
    },
    "confirm": {
      "type": "boolean",
      "description": "User confirmation status, true if the user has joined the team or false otherwise."
    },
    "email": {
      "type": "string",
      "description": "User email address."
    },
    "invited": {
      "type": "integer",
      "format": "int32",
      "description": "Date, the user has been invited to join the team in Unix timestamp."
    },
    "joined": {
      "type": "integer",
      "format": "int32",
      "description": "Date, the user has accepted the invitation to join the team in Unix timestamp."
    },
    "name": {
      "type": "string",
      "description": "User name."
    },
    "roles": {
      "type": "array",
      "description": "User list of roles",
      "items": {
        "type": "string"
      }
    },
    "teamId": {
      "type": "string",
      "description": "Team ID."
    },
    "userId": {
      "type": "string",
      "description": "User ID."
    }
  }
}