Server Members

Server membership

Write permission: own membership, server admin, or moderator

Update

PATCH

/api/v1/serverMembers/:id

Update a server member (e.g. nickname).

Parameters

Field	Type	Required
`mutedUntil`	`number`	No
`preferences`	`object`	No
`serverId`	`string`	Yes
`userId`	`string`	Yes
`hasClosedWelcome`	`boolean`	No
`joinedAt`	`number`	No

Example

Terminal

curl -X PATCH "https://start.chat/api/v1/serverMembers/{id}" \
  -H "Authorization: Bearer sk_live_xxx" \
  -H "Content-Type: application/json" \
  -d '{
    "serverId": "srv_abc123",
    "userId": "usr_abc123"
  }'

import { setup, mutate } from '@start-chat/sdk'

await setup({ apiKey: 'sk_live_xxx' })

const result = await mutate.serverMember.update({
  serverId: 'srv_abc123',
  userId: 'usr_abc123',
})

Response

{
  "ok": true,
  "data": {
    "serverId": "srv_abc123",
    "userId": "usr_abc123",
    "hasClosedWelcome": false,
    "joinedAt": 1709251200000
  }
}

Delete

DELETE

/api/v1/serverMembers/:id

Remove (kick) a member from the server.

Parameters

Field	Type	Required	Description
`id`	`string`	Yes

Example

Terminal

curl -X DELETE "https://start.chat/api/v1/serverMembers/{id}" \
  -H "Authorization: Bearer sk_live_xxx"

import { setup, mutate } from '@start-chat/sdk'

await setup({ apiKey: 'sk_live_xxx' })

const result = await mutate.serverMember.delete({
  id: 'abc123',
})

Response

{
  "ok": true,
  "data": {
    "serverId": "srv_abc123",
    "userId": "usr_abc123",
    "hasClosedWelcome": false,
    "joinedAt": 1709251200000
  }
}

Insert

POST

/api/v1/serverMembers

Add a user to the server.

Parameters

Field	Type	Required
`mutedUntil`	`number`	No
`preferences`	`object`	No
`serverId`	`string`	Yes

Example

Terminal

curl -X POST "https://start.chat/api/v1/serverMembers" \
  -H "Authorization: Bearer sk_live_xxx" \
  -H "Content-Type: application/json" \
  -d '{
    "serverId": "srv_abc123"
  }'

import { setup, mutate } from '@start-chat/sdk'

await setup({ apiKey: 'sk_live_xxx' })

const result = await mutate.serverMember.insert({
  serverId: 'srv_abc123',
})

Response

{
  "ok": true,
  "data": {
    "serverId": "srv_abc123",
    "userId": "usr_abc123",
    "hasClosedWelcome": false,
    "joinedAt": 1709251200000
  }
}

Servers

Threads