Add user to list

Add a single user to a user list

Permission Required: lists:write

POST /v2/access/users/lists/:listId/users/:userId

Add user to list

cURL

curl --request POST \
  --url https://api.ofauth.com/v2/access/users/lists/:listId/users/:userId \
  --header 'apiKey: <api-key>' \
  --header 'x-connection-id: <api-key>'

200

{
  "list": {
    "id": "<string>",
    "type": "<string>",
    "name": "<string>",
    "sortList": [
      {
        "order": "<string>",
        "direction": "<string>"
      }
    ],
    "users": [
      {
        "id": 123,
        "username": "<string>",
        "name": "<string>",
        "isVerified": true,
        "avatar": "<string>",
        "avatarThumbs": {
          "c50": "<string>",
          "c144": "<string>"
        }
      }
    ],
    "usersCount": 123,
    "postsCount": 123,
    "order": "<string>",
    "direction": "<string>",
    "canUpdate": true,
    "canDelete": true,
    "canManageUsers": true,
    "canAddUsers": true,
    "canPinnedToFeed": true,
    "isPinnedToFeed": true,
    "canPinnedToChat": true,
    "isPinnedToChat": true
  },
  "userState": {
    "id": "<string>",
    "type": "<string>",
    "name": "<string>",
    "hasUser": true,
    "canAddUser": true,
    "cannotAddUserReason": "<string>"
  }
}

Authorizations

apiKey · string · header · required

Your OFAuth API key for authenticating requests.

x-connection-id · string · header · required

Requires a connection via the x-connection-id header.

Path Parameters

listId · string · required

userId · string · required

Response

200

application/json

Successful response

Option 1

Option 2

list · object · required

Show child attributes

userState · object · required

Show child attributes