Loading...
Skip to main content

Update the membership of a member of this Team.

Update the membership of a member of this Team.

Path Parameters
    teamId string required

    The team to update a member in.

    userId string required

    The user ID to update.

Request Body required
    teamId string required

    The team to update a member in.

    userId string required

    The user ID to update.

    role object

    Represents a role that a User can have in a Team.

    isAdmin boolean

    True if the user is an admin for the team.

Responses

OK


Schema
    membership object

    Represents the membership of a User in a Team.

    teamId string

    The team ID.

    user object

    The user that is a member of this Team.

    userId string

    The unique user ID for this user.

    This field should not be populated in client requests.

    email string

    The email address for this user.

    fullName string

    The name of the user. This is only used for display purposes.

    avatarUrl string

    The URL of the avatar image for this user.

    created date-time

    When this user was created.

    This field should not be populated in client requests.

    modified date-time

    When this user was last modified.

    This field should not be populated in client requests.

    apiToken string

    The user's API token. This is only populated when a user accesses their own account information.

    lastLogin date-time

    When this user last logged in.

    This field should not be populated in client requests.

    subscriptions object[]

    The subscriptions for this user.

  • Array [
  • id string

    The unique ID for this subscription.

    type enum

    Possible values: [SUBSCRIPTION_TYPE_UNSPECIFIED, SUBSCRIPTION_TYPE_BUILDER, SUBSCRIPTION_TYPE_STARTER, SUBSCRIPTION_TYPE_PERFORMANCE, SUBSCRIPTION_TYPE_OTHER]

    The type of subscription this represents.

    state enum

    Possible values: [SUBSCRIPTION_STATE_UNSPECIFIED, SUBSCRIPTION_STATE_ACTIVE, SUBSCRIPTION_STATE_CANCELED, SUBSCRIPTION_STATE_EXPIRED, SUBSCRIPTION_STATE_CANCEL_PENDING]

    The state of this subscription.

    description string

    A description of this subscription.

    created date-time

    When this subscription was created. This may not represent when the subscription was active, due to backdating.

    modified date-time

    When this subscription was last modified.

    startTime date-time

    The timestamp when this subscription starts.

    endTime date-time

    The timestamp when this subscription ends. If this subscription is active and has not been canceled, it will renew at this time.

  • ]
  • role object

    The user's role on the Team.

    isAdmin boolean

    True if the user is an admin for the team.

    pending boolean

    Whether the membership is pending acceptance of an invitation by the user.

    created date-time

    When this membership was created.

    modified date-time

    When this membership was last modified.

Loading...