Contents

トピックメンバーを更新する

トピックにいるメンバーを追加したり削除したりします。

メソッド

POST

URL

https://typetalk.com/api/v1/topics/:topicId/members/update

スコープ

topic.write

URL パラメーター

名前説明
topicId数値トピック ID

フォームパラメーター

名前説明
addAccountIds[0], addAccountIds[1] … (任意)文字列追加するアカウント ID(組織のメンバーのみ)
addGroupIds[0], addGroupIds[1] … (任意)文字列追加するグループ ID
invitations[0].email, invitations[1].email … (任意)文字列招待したい人のメールアドレス
invitations[0].role, invitations[1].role … (任意)文字列招待したい人の役割
removeAccounts[0].id, removeAccounts[1].id … (任意)数値削除するアカウント ID
removeAccounts[0].cancelSpaceInvitation, removeAccounts[1].cancelSpaceInvitation … (任意)真偽値true の場合、このユーザの招待をキャンセルします。
removeGroupIds[0], removeGroupIds[1] … (任意)数値削除するグループ ID

レスポンスの例

{
  "topic": {
    "id": 208,
    "name": "IT Peeps",
    "description": "",
    "suggestion": "IT Peeps",
    "isDirectMessage": false,
    "lastPostedAt": "2016-12-21T10:12:02Z",
    "createdAt": "2014-06-10T02:32:29Z",
    "updatedAt": "2014-06-10T02:32:29Z"
  },
  "mySpace": {
    "space": {
      "key": "abcdefghij",
      "name": "Joe Tech Inc.",
      "enabled": true,
      "imageUrl": "https://apps.nulab.com/spaces/abcdefghij/photo/large"
    },
    "myRole": "ADMIN",
    "isPaymentAdmin": true,
    "myPlan": {
      "plan": {
        "key": "typetalk.free",
        "name": "Free Plan",
        "limitNumberOfUsers": 10,
        "limitTotalAttachmentSize": 1073741824
      },
      "enabled": true,
      "trial": null,
      "numberOfUsers": 7,
      "totalAttachmentSize": 0,
      "createdAt": "2016-01-10T02:32:29Z",
      "updatedAt": "2016-12-21T10:12:16Z"
    }
  },
  "teams": [],
  "groups": [],
  "accounts": [
    {
      "id": 105,
      "name": "brad",
      "fullName": "BradMarshalls",
      "suggestion": "BradMarshalls",
      "imageUrl": "https://typetalk.com/accounts/105/profile_image.png?t=1404009149000",
      "isBot": false,
      "createdAt": "2014-06-29T02:32:29Z",
      "updatedAt": "2014-06-29T02:32:29Z"
    },
    {
      "id": 104,
      "name": "cooper",
      "fullName": "CooperDaChopper",
      "suggestion": "CooperDaChopper",
      "imageUrl": "https://typetalk.com/accounts/104/profile_image.png?t=1403922749000",
      "isBot": false,
      "createdAt": "2014-06-28T02:32:29Z",
      "updatedAt": "2014-06-28T02:32:29Z"
    },
    {
      "id": 100,
      "name": "jessica",
      "fullName": "Jessica Fitzherbert",
      "suggestion": "Jessica Fitzherbert",
      "imageUrl": "https://typetalk.com/accounts/100/profile_image.png?t=1403577149000",
      "isBot": false,
      "createdAt": "2014-06-24T02:32:29Z",
      "updatedAt": "2014-06-24T02:32:29Z"
    }
  ],
  "invitingAccounts": [],
  "invites": [],
  "accountsForApi": [],
  "integrations": [],
  "remainingInvitations": null
}

レスポンスのフォーマットは全て JSON です。GET メソッドは ETag に対応しているので、If-None-Match ヘッダを付けて送ると、変更がない場合は 304 を返します。日付のフォーマットは ISO 8601 で、UTC です。 (例 : 2014-01-09T06:20:08Z )