Update Team Members (By ID)

Request

POST

https://api.sourcecraft.tech/teams/id:{team_id}/members

Path parameters

Name

Description

team_id

Type: string

Example: ``

Query parameters

Name

Description

team_slug

Type: string

Example: ``

Body

application/json

{
  "members_delta": [
    {
      "action": "add",
      "user_id": "example",
      "user_slug": "example",
      "invitee_id": "example"
    }
  ]
}

Name	Description
members_delta	Type: TeamMemberDelta[] Example `[ { "action": "add", "user_id": "example", "user_slug": "example", "invitee_id": "example" } ]`

DeltaAction

Type: string

Enum: add, remove

TeamMemberDelta

Name	Description
action	Type: DeltaAction Enum: `add`, `remove`
invitee_id	Type: string Pending invitee by subject ID (same as `Subject.id` when `Subject.type`=`invitee`, see `Invite.subject`). Example: `example`
user_id	Type: string Registered user by UUID (`UserEmbedded.id`, same as `Subject.id` when `Subject.type`=`user`). Example: `example`
user_slug	Type: string Registered user by slug. Example: `example`

Example

{
  "action": "add",
  "user_id": "example",
  "user_slug": "example",
  "invitee_id": "example"
}

Responses

200 OK

A successful response.

Body

application/json

{
  "members": [
    {
      "subject": {
        "type": "user",
        "id": "example"
      },
      "user": {
        "id": "example",
        "slug": "example"
      }
    }
  ]
}

Name	Description
members	Type: TeamMember[] Example `[ { "subject": { "type": "user", "id": "example" }, "user": { "id": "example", "slug": "example" } } ]`

SubjectType

Type: string

Enum: user, invitee, team

Subject

Name

Description

Type: string

Example: example

type

Type: SubjectType

Enum: user, invitee, team

Example

{
  "type": "user",
  "id": "example"
}

UserEmbedded

Name

Description

Type: string

Example: example

slug

Type: string

Example: example

Example

{
  "id": "example",
  "slug": "example"
}

TeamMember

TeamMember represents a team member. subject.type is user or invitee.

Name	Description
subject	Type: Subject Example `{ "type": "user", "id": "example" }`
user	Type: UserEmbedded Example `{ "id": "example", "slug": "example" }`

Example

{
  "subject": {
    "type": "user",
    "id": "example"
  },
  "user": {
    "id": "example",
    "slug": "example"
  }
}

default

Both Client Errors (4xx) and Server Errors (5xx) are serialized into this scheme

Body

application/json

{
  "error_code": "example",
  "message": "example",
  "request_id": "example",
  "details": null
}

Name	Description
details	Type: unknown Example: `null`
error_code	Type: string Example: `example`
message	Type: string Example: `example`
request_id	Type: string Example: `example`

Was the article helpful?

List Team Members (By ID)

Overview