tools.ozone.team.addMember

POST /xrpc/tools.ozone.team.addMember

This endpoint is part of the Ozone moderation service APIs. Requests usually require authentication, are directed to the user's PDS intance, and proxied to the Ozone instance indicated by the DID in the service proxying header. Admin authenentication may also be possible, with request sent directly to the Ozone instance.

To learn more about calling atproto API endpoints like this one, see the API Hosts and Auth guide.

Add a member to the ozone team. Requires admin role.

Request

application/json

Body

required

did didrequired

role stringrequired

Possible values: [tools.ozone.team.defs#roleAdmin, tools.ozone.team.defs#roleModerator, tools.ozone.team.defs#roleTriage]

Responses

application/json

Schema
Example (from schema)

Schema

did didrequired

disabled boolean

profile

object

did didrequired

handle handlerequired

displayName string

Possible values: <= 640 characters

description string

Possible values: <= 2560 characters

avatar uri

banner uri

followersCount integer

followsCount integer

postsCount integer

associated

object

lists integer

feedgens integer

starterPacks integer

labeler boolean

chat

object

allowIncoming stringrequired

Possible values: [all, none, following]

joinedViaStarterPack

object

uri at-urirequired

cid cidrequired

record required

creator

object

required

did didrequired

handle handlerequired

displayName string

Possible values: <= 640 characters

avatar uri

associated

object

lists integer

feedgens integer

starterPacks integer

labeler boolean

chat

object

allowIncoming stringrequired

Possible values: [all, none, following]

viewer

object

Metadata about the requesting account's relationship with the subject account. Only has meaningful content for authed requests.

muted boolean

mutedByList

object

uri at-urirequired

cid cidrequired

name stringrequired

Possible values: non-empty and <= 64 characters

purpose

object

required

oneOf

app.bsky.graph.defs.modlist
app.bsky.graph.defs.curatelist
app.bsky.graph.defs.referencelist

string

avatar uri

listItemCount integer

labels

object[]

Array [

ver integer

src didrequired

DID of the actor who created this label.

uri urirequired

AT URI of the record, repository (account), or other resource that this label applies to.

cid cid

Optionally, CID specifying the specific version of 'uri' resource this label applies to.

val stringrequired

Possible values: <= 128 characters

The short string name of the value or type of this label.

neg boolean

If true, this is a negation label, overwriting a previous label.

cts date-timerequired

Timestamp when this label was created.

exp date-time

Timestamp at which this label expires (no longer applies).

sig byte

Signature of dag-cbor encoded label.

]

viewer

object

muted boolean

blocked at-uri

indexedAt date-time

blockedBy boolean

blocking at-uri

blockingByList

object

uri at-urirequired

cid cidrequired

name stringrequired

Possible values: non-empty and <= 64 characters

purpose

object

required

oneOf

app.bsky.graph.defs.modlist
app.bsky.graph.defs.curatelist
app.bsky.graph.defs.referencelist

string

avatar uri

listItemCount integer

labels

object[]

Array [

ver integer

src didrequired

DID of the actor who created this label.

uri urirequired

AT URI of the record, repository (account), or other resource that this label applies to.

cid cid

Optionally, CID specifying the specific version of 'uri' resource this label applies to.

val stringrequired

Possible values: <= 128 characters

The short string name of the value or type of this label.

neg boolean

If true, this is a negation label, overwriting a previous label.

cts date-timerequired

Timestamp when this label was created.

exp date-time

Timestamp at which this label expires (no longer applies).

sig byte

Signature of dag-cbor encoded label.

]

viewer

object

muted boolean

blocked at-uri

indexedAt date-time

following at-uri

followedBy at-uri

knownFollowers

object

The subject's followers whom you also follow

count integerrequired

followers undefined[]required

Possible values: <= 5

labels

object[]

Array [

ver integer

src didrequired

DID of the actor who created this label.

uri urirequired

AT URI of the record, repository (account), or other resource that this label applies to.

cid cid

Optionally, CID specifying the specific version of 'uri' resource this label applies to.

val stringrequired

Possible values: <= 128 characters

The short string name of the value or type of this label.

neg boolean

If true, this is a negation label, overwriting a previous label.

cts date-timerequired

Timestamp when this label was created.

exp date-time

Timestamp at which this label expires (no longer applies).

sig byte

Signature of dag-cbor encoded label.

]

createdAt date-time

listItemCount integer

joinedWeekCount integer

joinedAllTimeCount integer

labels

object[]

Array [

ver integer

src didrequired

DID of the actor who created this label.

uri urirequired

AT URI of the record, repository (account), or other resource that this label applies to.

cid cid

Optionally, CID specifying the specific version of 'uri' resource this label applies to.

val stringrequired

Possible values: <= 128 characters

The short string name of the value or type of this label.

neg boolean

If true, this is a negation label, overwriting a previous label.

cts date-timerequired

Timestamp when this label was created.

exp date-time

Timestamp at which this label expires (no longer applies).

sig byte

Signature of dag-cbor encoded label.

]

indexedAt date-timerequired

indexedAt date-time

createdAt date-time

viewer

object

Metadata about the requesting account's relationship with the subject account. Only has meaningful content for authed requests.

muted boolean

mutedByList

object

uri at-urirequired

cid cidrequired

name stringrequired

Possible values: non-empty and <= 64 characters

purpose

object

required

oneOf

app.bsky.graph.defs.modlist
app.bsky.graph.defs.curatelist
app.bsky.graph.defs.referencelist

string

avatar uri

listItemCount integer

labels

object[]

Array [

ver integer

src didrequired

DID of the actor who created this label.

uri urirequired

AT URI of the record, repository (account), or other resource that this label applies to.

cid cid

Optionally, CID specifying the specific version of 'uri' resource this label applies to.

val stringrequired

Possible values: <= 128 characters

The short string name of the value or type of this label.

neg boolean

If true, this is a negation label, overwriting a previous label.

cts date-timerequired

Timestamp when this label was created.

exp date-time

Timestamp at which this label expires (no longer applies).

sig byte

Signature of dag-cbor encoded label.

]

viewer

object

muted boolean

blocked at-uri

indexedAt date-time

blockedBy boolean

blocking at-uri

blockingByList

object

uri at-urirequired

cid cidrequired

name stringrequired

Possible values: non-empty and <= 64 characters

purpose

object

required

oneOf

app.bsky.graph.defs.modlist
app.bsky.graph.defs.curatelist
app.bsky.graph.defs.referencelist

string

avatar uri

listItemCount integer

labels

object[]

Array [

ver integer

src didrequired

DID of the actor who created this label.

uri urirequired

AT URI of the record, repository (account), or other resource that this label applies to.

cid cid

Optionally, CID specifying the specific version of 'uri' resource this label applies to.

val stringrequired

Possible values: <= 128 characters

The short string name of the value or type of this label.

neg boolean

If true, this is a negation label, overwriting a previous label.

cts date-timerequired

Timestamp when this label was created.

exp date-time

Timestamp at which this label expires (no longer applies).

sig byte

Signature of dag-cbor encoded label.

]

viewer

object

muted boolean

blocked at-uri

indexedAt date-time

following at-uri

followedBy at-uri

knownFollowers

object

The subject's followers whom you also follow

count integerrequired

followers

object[]

required

Possible values: < 5

Array [

did didrequired

handle handlerequired

displayName string

Possible values: <= 640 characters

avatar uri

associated

object

lists integer

feedgens integer

starterPacks integer

labeler boolean

chat

object

allowIncoming stringrequired

Possible values: [all, none, following]

viewer

labels

object[]

Array [

ver integer

src didrequired

DID of the actor who created this label.

uri urirequired

AT URI of the record, repository (account), or other resource that this label applies to.

cid cid

Optionally, CID specifying the specific version of 'uri' resource this label applies to.

val stringrequired

Possible values: <= 128 characters

The short string name of the value or type of this label.

neg boolean

If true, this is a negation label, overwriting a previous label.

cts date-timerequired

Timestamp when this label was created.

exp date-time

Timestamp at which this label expires (no longer applies).

sig byte

Signature of dag-cbor encoded label.

]

createdAt date-time

]

labels

object[]

Array [

ver integer

src didrequired

DID of the actor who created this label.

uri urirequired

AT URI of the record, repository (account), or other resource that this label applies to.

cid cid

Optionally, CID specifying the specific version of 'uri' resource this label applies to.

val stringrequired

Possible values: <= 128 characters

The short string name of the value or type of this label.

neg boolean

If true, this is a negation label, overwriting a previous label.

cts date-timerequired

Timestamp when this label was created.

exp date-time

Timestamp at which this label expires (no longer applies).

sig byte

Signature of dag-cbor encoded label.

]

pinnedPost

object

uri at-urirequired

cid cidrequired

createdAt date-time

updatedAt date-time

lastUpdatedBy string

role stringrequired

Possible values: [#roleAdmin, #roleModerator, #roleTriage]

{
  "did": "string",
  "disabled": true,
  "profile": {
    "did": "string",
    "handle": "string",
    "displayName": "string",
    "description": "string",
    "avatar": "string",
    "banner": "string",
    "followersCount": 0,
    "followsCount": 0,
    "postsCount": 0,
    "associated": {
      "lists": 0,
      "feedgens": 0,
      "starterPacks": 0,
      "labeler": true,
      "chat": {
        "allowIncoming": "all"
      }
    },
    "joinedViaStarterPack": {
      "uri": "string",
      "cid": "string",
      "record": {},
      "creator": {
        "did": "string",
        "handle": "string",
        "displayName": "string",
        "avatar": "string",
        "associated": {
          "lists": 0,
          "feedgens": 0,
          "starterPacks": 0,
          "labeler": true,
          "chat": {
            "allowIncoming": "all"
          }
        },
        "viewer": {
          "muted": true,
          "mutedByList": {
            "uri": "string",
            "cid": "string",
            "name": "string",
            "purpose": "string",
            "avatar": "string",
            "listItemCount": 0,
            "labels": [
              {
                "ver": 0,
                "src": "string",
                "uri": "string",
                "cid": "string",
                "val": "string",
                "neg": true,
                "cts": "2024-11-04T00:29:30.335Z",
                "exp": "2024-11-04T00:29:30.335Z",
                "sig": "string"
              }
            ],
            "viewer": {
              "muted": true,
              "blocked": "string"
            },
            "indexedAt": "2024-11-04T00:29:30.335Z"
          },
          "blockedBy": true,
          "blocking": "string",
          "blockingByList": {
            "uri": "string",
            "cid": "string",
            "name": "string",
            "purpose": "string",
            "avatar": "string",
            "listItemCount": 0,
            "labels": [
              {
                "ver": 0,
                "src": "string",
                "uri": "string",
                "cid": "string",
                "val": "string",
                "neg": true,
                "cts": "2024-11-04T00:29:30.335Z",
                "exp": "2024-11-04T00:29:30.335Z",
                "sig": "string"
              }
            ],
            "viewer": {
              "muted": true,
              "blocked": "string"
            },
            "indexedAt": "2024-11-04T00:29:30.335Z"
          },
          "following": "string",
          "followedBy": "string",
          "knownFollowers": {
            "count": 0,
            "followers": [
              null
            ]
          }
        },
        "labels": [
          {
            "ver": 0,
            "src": "string",
            "uri": "string",
            "cid": "string",
            "val": "string",
            "neg": true,
            "cts": "2024-11-04T00:29:30.336Z",
            "exp": "2024-11-04T00:29:30.336Z",
            "sig": "string"
          }
        ],
        "createdAt": "2024-11-04T00:29:30.336Z"
      },
      "listItemCount": 0,
      "joinedWeekCount": 0,
      "joinedAllTimeCount": 0,
      "labels": [
        {
          "ver": 0,
          "src": "string",
          "uri": "string",
          "cid": "string",
          "val": "string",
          "neg": true,
          "cts": "2024-11-04T00:29:30.336Z",
          "exp": "2024-11-04T00:29:30.336Z",
          "sig": "string"
        }
      ],
      "indexedAt": "2024-11-04T00:29:30.336Z"
    },
    "indexedAt": "2024-11-04T00:29:30.336Z",
    "createdAt": "2024-11-04T00:29:30.336Z",
    "viewer": {
      "muted": true,
      "mutedByList": {
        "uri": "string",
        "cid": "string",
        "name": "string",
        "purpose": "string",
        "avatar": "string",
        "listItemCount": 0,
        "labels": [
          {
            "ver": 0,
            "src": "string",
            "uri": "string",
            "cid": "string",
            "val": "string",
            "neg": true,
            "cts": "2024-11-04T00:29:30.336Z",
            "exp": "2024-11-04T00:29:30.336Z",
            "sig": "string"
          }
        ],
        "viewer": {
          "muted": true,
          "blocked": "string"
        },
        "indexedAt": "2024-11-04T00:29:30.336Z"
      },
      "blockedBy": true,
      "blocking": "string",
      "blockingByList": {
        "uri": "string",
        "cid": "string",
        "name": "string",
        "purpose": "string",
        "avatar": "string",
        "listItemCount": 0,
        "labels": [
          {
            "ver": 0,
            "src": "string",
            "uri": "string",
            "cid": "string",
            "val": "string",
            "neg": true,
            "cts": "2024-11-04T00:29:30.336Z",
            "exp": "2024-11-04T00:29:30.336Z",
            "sig": "string"
          }
        ],
        "viewer": {
          "muted": true,
          "blocked": "string"
        },
        "indexedAt": "2024-11-04T00:29:30.336Z"
      },
      "following": "string",
      "followedBy": "string",
      "knownFollowers": {
        "count": 0,
        "followers": [
          {
            "did": "string",
            "handle": "string",
            "displayName": "string",
            "avatar": "string",
            "associated": {
              "lists": 0,
              "feedgens": 0,
              "starterPacks": 0,
              "labeler": true,
              "chat": {
                "allowIncoming": "all"
              }
            },
            "labels": [
              {
                "ver": 0,
                "src": "string",
                "uri": "string",
                "cid": "string",
                "val": "string",
                "neg": true,
                "cts": "2024-11-04T00:29:30.336Z",
                "exp": "2024-11-04T00:29:30.336Z",
                "sig": "string"
              }
            ],
            "createdAt": "2024-11-04T00:29:30.336Z"
          }
        ]
      }
    },
    "labels": [
      {
        "ver": 0,
        "src": "string",
        "uri": "string",
        "cid": "string",
        "val": "string",
        "neg": true,
        "cts": "2024-11-04T00:29:30.336Z",
        "exp": "2024-11-04T00:29:30.336Z",
        "sig": "string"
      }
    ],
    "pinnedPost": {
      "uri": "string",
      "cid": "string"
    }
  },
  "createdAt": "2024-11-04T00:29:30.336Z",
  "updatedAt": "2024-11-04T00:29:30.336Z",
  "lastUpdatedBy": "string",
  "role": "#roleAdmin"
}

Bad Request

application/json

Schema
Example (from schema)

Schema

error stringrequired

Possible values: [InvalidRequest, ExpiredToken, InvalidToken, MemberAlreadyExists]

message stringrequired

{
  "error": "InvalidRequest",
  "message": "string"
}

Unauthorized

application/json

Schema
Example (from schema)

Schema

error required

message stringrequired

{
  "message": "string"
}

tools.ozone.team.addMember

/xrpc/tools.ozone.team.addMember

Request​

Body

Responses​

Request

Responses