Manage topic members

Add or remove members from a topic.

Method

POST

URL

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

Scope

topic.write

URL parameters

Name	Type	Description
topicId	Number	Topic ID

Form parameters

Name	Type	Description
addAccountIds[0], addAccountIds[1] … (Optional)	String	Account ID that you want to add (organization member only)
addGroupIds[0], addGroupIds[1] … (Optional)	String	Group ID that you want to add
invitations[0].email, invitations[1].email … (Optional)	String	Email address that you want to invite
invitations[0].role, invitations[1].role … (Optional)	String	Role that you want to invite
removeAccounts[0].id, removeAccounts[1].id … (Optional)	Number	Account ID that you want to remove
removeAccounts[0].cancelSpaceInvitation, removeAccounts[1].cancelSpaceInvitation … (Optional)	Boolean	If this is true, the user invitation will be removed
removeGroupIds[0], removeGroupIds[1] … (Optional)	Number	Group ID that you want to remove

Response Example

{
  "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
}

All responses are formatted in JSON and include an ETag. If you call an API with an If-None-Match header, the server will return a 304 status code if the data is unchanged. The date and time format is ISO 8601, and the timezone is UTC (eg. 2014-01-09T06:20:08Z).