Conversations · Channelize.io

Channelize.io supports 4 types of conversations: 1-to-1, Private Groups, Public Groups & Open Conversations.

Private 1-to-1: To create a private 1-to-1 conversation, set the query parameter type to private and isGroup to false. This group will have only 2 members.
Private Group: To create a private group conversation, set the query parameter type to private and isGroup to true. Only group admin can add/remove members in the group. You have to be a member to send/receive messages.
Public Group: To create a public group conversation, set the query parameter type to public and isGroup to true. The users have to join the conversation before sending the message and the users can freely join the conversation themselves.
Open Conversation: To create a open conversation, set the query parameter type to open and isGroup to true. We don't need to specify members for Open Conversation as the users can send/receive messages by watching only.

This table contains all conversations types and their permissions:

Feature	Private 1-to-1	Private Group	Public Group	Open Conversation
Conversation access	Conversation Members	Conversation Members	All Application Users	All Application Users
Add/Remove Members	No One	The Conversation admin can add and remove members.	The Conversation admin can add and remove members.	The Conversation admin can add and remove members.
Join Conversation	No One	No One	The members can join the Conversation anytime.	No One
Leave Conversation	No One	The Conversation admin and members can leave the Conversation.	The Conversation admin and members can leave the Conversation.	The Conversation admin and members can leave the Conversation.
Start/Stop Watching	No One	Conversation Members	Conversation Members	All Application Users
Send Message	Conversation Members	Conversation Members and Watchers	Conversation Members and Watchers	Conversation Members and Watchers
Delete Messages (Own Copy)	Conversation Members	Conversation Members	No One	No One
Delete Messages for Everyone	Message owner can delete the message.	Message owner can delete the message.	Message owner can delete the message.	Message owner can delete the message.
Add/Remove Reactions	Conversation members can add/remove a reaction on received messages.	Conversation members can add/remove a reaction on received messages.	Conversation members can add/remove a reaction on received messages.	Conversation members and watchers can add/remove a reaction on received messages.

This section contains what all conversations related actions can be performed using Application APIs.

List Conversations

Retrieves the list of conversations of a user.

GET https://api.channelize.io/v2/conversations

Query Params

This table lists all parameters this API request supports to get filtered results.

Parameter	Type	Required	Default	Description
ids	string	no	null	Specifies a comma-separated string of conversation IDs to retrieve.
isGroup	boolean	no	null	Restricts the search scope to only retrieve private 1-to-1 or group conversations. Allowed values are `true` and `false`. By default, all the conversations are retrieved.
type	string	no	null	Specifies the type of conversation. Allowed values are `private`, `public` and `open`. By default, all the conversations are retrieved.
customTypes	string	no	null	Specifies a comma-separated string of one or more custom types to filter the conversations.
search	string	no	null	Specifies the name of the conversation to retrieve.
membersIncluded	string	no	null	Specifies a comma-separated string of one or more user IDs to restrict search scope. Example: user_id_1, user_id_2.
membersExactly	string	no	null	Searches for conversations with the specified members exactly in. The string should contain comma-separated multiple user IDs Example: user_id_1, user_id_2.
includeDeleted	boolean	no	false	Determines whether to include deleted conversation in response.
includeOnlyActive	string	no	false	Restricts the search scope to retrieve only conversations in which the user is active.
publicMode	boolean	no	false	Retrieves public conversation that the logged-in user is not a part of. This parameter only works when the type is set to the public.
sort	string	no	updatedAt DESC	Specifies the sorting criteria for the returned results. Allowed values are updatedAt ASC and updatedAt DESC.
include	string	no	null	Specifies extra fields if you want extra information to be appended with the conversation objects. Allowed values are `members`.
limit	int	no	25	Specifies the number of results to return.
skip	int	no	0	Specifies the number of results you want to skip from the beginning. (Useful in Pagination)

Request Example

https://api.channelize.io/v2/conversations?includeDeleted=false&limit=10

Response

Status Code: 200

[
  {
    "id": "1021",
    "title": "Test Group",
    "memberCount": 3,
    "watchersCount": 3,
    "isGroup": true,
    "ownerId": "18646",
    "createdAt": "2017-08-24T12:05:06.000Z",
    "type": "private",
    "config": {
      "typing_events": true,
      "read_events": true,
      "push_notification": true,
      "pin_messages": false
    },
    "customType" : "messaging",
    "metaData": [],
    "lastReadAt": {
      "18646": "2020-01-29T06:48:53.700Z",
      "18664": "2020-01-29T07:12:41.613Z",
      "18714": "2020-01-29T07:12:41.613Z"
    },
    "unreadMessageCount": 0,
    "mute": false,
    "isActive": true,
    "isAdmin": true,
    "isDeleted": false,
    "updatedAt": "2020-01-29T07:12:41.124Z",
    "lastMessage": {
      "id": "18a16164-657c-420a-887d-5408f1479619",
      "conversationId": "1021",
      "type": "normal",
      "createdAt": "2020-01-29T07:12:41.124Z",
      "updatedAt": "2020-01-29T07:12:41.124Z",
      "body": "hi",
      "ownerId": "18646",
      "attachments": [],
      "owner": {
          "id": "18646",
          "displayName": "sydney millers",
          "profileImageUrl": "https://sample-file-url/media/fbef1bb47eb85fb2979b135ed04e0eb3.png"
      },
      "mentionedUsers": []
    },
    "members": [
      {
        "id": "89c7e350-4265-11ea-9c07-831a487bf6af",
        "userId": "18646",
        "isAdmin": true,
        "user": {
          "id": "18646",
          "displayName": "alex de bougex",
          "profileImageUrl": "https://sample-file-url/media/ff29_078f.jpg",
          "metaData": {
              "secondaryField": null
          },
          "profileUrl": "http://devaddons1.socialengineaddons.com/mobiledemodevelopment/profile/alx2bgx",
          "isOnline": false,
          "notification": true,
          "lastSeen": "2020-01-10T13:44:36.000Z"
        }
      },
      {
        "id": "89c7e351-4265-11ea-9c07-831a487bf6af",
        "userId": "18664",
        "isAdmin": false,
        "user": {
          "id": "18664",
          "displayName": "antonis chatzipetrou",
          "profileImageUrl": "http://sample-file-url/media/fff4_0edb.jpg",
          "metaData": {
            "secondaryField": null
          },
          "profileUrl": "http://devaddons1.socialengineaddons.com/mobiledemodevelopment/profile/AntonisChatzipetrou",
          "isOnline": false,
          "notification": true,
          "lastSeen": "2020-01-10T13:44:36.000Z"
        }
      },
      {
        "id": "89c7e352-4265-11ea-9c07-831a487bf6af",
        "userId": "18714",
        "isAdmin": false,
        "user": {
          "id": "18714",
          "displayName": "alle cavallaro",
          "profileImageUrl": "http://sample-file-url/mediea/10263_dd51.jpg",
          "metaData": {
            "secondaryField": null
          },
          "profileUrl": "http://devaddons1.socialengineaddons.com/mobiledemodevelopment/profile/AlleCavallaro",
          "isOnline": false,
          "notification": true,
          "lastSeen": "2020-01-10T13:44:36.000Z"
        }
      }
    ]
  }
]

Create a Conversation

Creates a new conversation.

POST https://api.channelize.io/v2/conversations

Request Body

Parameter	Type	Required	Default	Description
id	string	no	auto generated	The unique ID of the conversation.
isGroup	boolean	no	true	Determines whether to create a group conversation or private 1-to-1 conversation. If set to `true`, group conversation will create. If set to `false`, a private 1-to-1 conversation will create.
type	string	no	private	The conversation type. Allowed values are `private`, `public` and `open`.
customType	string	no	null	Specify the custom type of conversation which is used for grouping like `messaging`, `live_streaming`, `gaming` etc.
title	string	Required for group conversation	null	The title of the conversation.
profileImageUrl	string	Required for group conversation	null	The URL of the conversation's profile image.
members	array	yes	-	Specifies an array of user IDs to add to the conversation. E.g. ["USER_ID_1", "USER_ID_2"]
createdAt	date	no	Auto Generated	The timestamp when the conversation was created.
config	object	no	object	Specifies the configurations for a conversation. You can enable/disable certain functionalities on conversation level using this property. Config properties are described in a separate section below.
metaData	object	no	null	Additional information of the conversation that you can save like tags etc.

Config properties

read_events If disabled, unreadMessageCount will not update for a recipient when a new message is sent in a conversation. Also, the count of users read a message will not update. By default, it is enabled for private conversations but disabled for public conversations.
typing_events Determines whether to enable start typing and stop typing events for a conversation. By default, it is enabled for private conversations but disabled for public conversations.
push_notifications Determines whether to enable push notifications for a conversation. By default, push notifications are enabled for private conversations but disabled for public conversations.
pin_messages Determines whether to enable pin messages feature for a conversation. By default, pin messages feature is enabled for open conversations but disabled for public and private conversations.

Request Body For Private Group Conversations

{
  "type": "private",
  "isGroup": true,
  "title": "Test_group",
  "profileImageUrl": "http://sample-file-url/media/b5ceb45b2d6c74e4fc89673a5675c09c.jpg",
  "members": [
       "USER_ID_1", "USER_ID_2",  "USER_ID_3"
  ],
  "customType": "messaging",
  "metaData": {
    "tags": ["private_conversations"]
  }
}

Request Body Private 1-to-1 Conversations

{
  "type": "private",
  "isGroup": false,
  "members": [
      "USER_ID_1", "USER_ID_2"
  ],
  "customType": "messaging"
}

Request Body Public Group Conversations

{
  "type": "public",
  "isGroup": true,
  "members": [
      "USER_ID_1", "USER_ID_2", "USER_ID_3"
  ],
  "customType": "messaging"
}

Response

Status Code: 201

{
  "id": "1021",
  "title": "Test Group",
  "memberCount": 3,
  "watchersCount": 0,
  "isGroup": true,
  "ownerId": "18646",
  "createdAt": "2017-08-24T12:05:06.000Z",
  "type": "private",
  "config": {
    "typing_events": true,
    "read_events": true,
    "push_notification": true,
    "pin_messages": false
  },
  "customType" : "messaging",
  "metaData": {
    "tags": ["test_group"]
  },
  "lastReadAt": {
    "18646": "2020-01-29T06:48:53.700Z",
    "18664": "2020-01-29T07:12:41.613Z",
    "18714": "2020-01-29T07:12:41.613Z"
  },
  "unreadMessageCount": 0,
  "mute": false,
  "isActive": true,
  "isAdmin": true,
  "isDeleted": false,
  "updatedAt": "2020-01-29T07:12:41.124Z",
  "lastMessage": {
    "id": "18a16164-657c-420a-887d-5408f1479619",
    "conversationId": "1021",
    "type": "normal",
    "createdAt": "2020-01-29T07:12:41.124Z",
    "updatedAt": "2020-01-29T07:12:41.124Z",
    "body": "hi",
    "ownerId": "18646",
    "attachments": [],
    "owner": {
        "id": "18646",
        "displayName": "sydney millers",
        "profileImageUrl": "https://sample-file-url/media/fbef1bb47eb85fb2979b135ed04e0eb3.png"
    },
    "mentionedUsers": []
  },
  "members": [
    {
      "id": "89c7e350-4265-11ea-9c07-831a487bf6af",
      "userId": "18646",
      "isAdmin": true,
      "user": {
        "id": "18646",
        "displayName": "alex de bougex",
        "profileImageUrl": "https://sample-file-url/media/ff29_078f.jpg",
        "metaData": {
            "secondaryField": null
        },
        "profileUrl": "http://devaddons1.socialengineaddons.com/mobiledemodevelopment/profile/alx2bgx",
        "isOnline": false,
        "notification": true,
        "lastSeen": "2020-01-10T13:44:36.000Z"
      }
    },
    {
      "id": "89c7e351-4265-11ea-9c07-831a487bf6af",
      "userId": "18664",
      "isAdmin": false,
      "user": {
        "id": "18664",
        "displayName": "antonis chatzipetrou",
        "profileImageUrl": "http://sample-file-url/media/fff4_0edb.jpg",
        "metaData": {
          "secondaryField": null
        },
        "profileUrl": "http://devaddons1.socialengineaddons.com/mobiledemodevelopment/profile/AntonisChatzipetrou",
        "isOnline": false,
        "notification": true,
        "lastSeen": "2020-01-10T13:44:36.000Z"
      }
    },
    {
      "id": "89c7e352-4265-11ea-9c07-831a487bf6af",
      "userId": "18714",
      "isAdmin": false,
      "user": {
        "id": "18714",
        "displayName": "alle cavallaro",
        "profileImageUrl": "http://sample-file-url/mediea/10263_dd51.jpg",
        "metaData": {
          "secondaryField": null
        },
        "profileUrl": "http://devaddons1.socialengineaddons.com/mobiledemodevelopment/profile/AlleCavallaro",
        "isOnline": false,
        "notification": true,
        "lastSeen": "2020-01-10T13:44:36.000Z"
      }
    }
  ]
}

Get a Conversation

Retrieves information about a conversation. You can also get additional details in the conversation object using include parameter.

GET https://api.channelize.io/v2/conversations/{conversation_id}

Path Params

This table lists all parameters this API request supports.

Parameter	Type	Required	Default	Description
conversation_id	string	yes	-	The unique ID of the conversation to retrieve.

Query Params

This table lists all parameters this API request supports to get filtered results.

Parameter	Type	Required	Default	Description
include	string	no	null	Specifies extra fields if you want extra information to be appended with the conversation objects. Allowed values are `members`.

Request Example

https://api.channelize.io/v2/conversations/42ab4d40-666a-11e9-bdcd-0bf68210bf49

Response

Status Code: 200

{
  "id": "1021",
  "title": "Test Group",
  "memberCount": 3,
  "watchersCount": 3,
  "isGroup": true,
  "ownerId": "18646",
  "createdAt": "2017-08-24T12:05:06.000Z",
  "type": "private",
  "config": {
    "typing_events": true,
    "read_events": true,
    "push_notification": true,
    "pin_messages": false
  },
  "customType" : "messaging",
  "metaData": [],
  "lastReadAt": {
    "18646": "2020-01-29T06:48:53.700Z",
    "18664": "2020-01-29T07:12:41.613Z",
    "18714": "2020-01-29T07:12:41.613Z"
  },
  "unreadMessageCount": 0,
  "mute": false,
  "isActive": true,
  "isAdmin": true,
  "isDeleted": false,
  "updatedAt": "2020-01-29T07:12:41.124Z",
  "lastMessage": {
    "id": "18a16164-657c-420a-887d-5408f1479619",
    "conversationId": "1021",
    "type": "normal",
    "createdAt": "2020-01-29T07:12:41.124Z",
    "updatedAt": "2020-01-29T07:12:41.124Z",
    "body": "hi",
    "ownerId": "18646",
    "attachments": [],
    "owner": {
        "id": "18646",
        "displayName": "sydney millers",
        "profileImageUrl": "https://sample-file-url/media/fbef1bb47eb85fb2979b135ed04e0eb3.png"
    },
    "mentionedUsers": []
  },
  "members": [
    {
      "id": "89c7e350-4265-11ea-9c07-831a487bf6af",
      "userId": "18646",
      "isAdmin": true,
      "user": {
        "id": "18646",
        "displayName": "alex de bougex",
        "profileImageUrl": "https://sample-file-url/media/ff29_078f.jpg",
        "metaData": {
            "secondaryField": null
        },
        "profileUrl": "http://devaddons1.socialengineaddons.com/mobiledemodevelopment/profile/alx2bgx",
        "isOnline": false,
        "notification": true,
        "lastSeen": "2020-01-10T13:44:36.000Z"
      }
    },
    {
      "id": "89c7e351-4265-11ea-9c07-831a487bf6af",
      "userId": "18664",
      "isAdmin": false,
      "user": {
        "id": "18664",
        "displayName": "antonis chatzipetrou",
        "profileImageUrl": "http://sample-file-url/media/fff4_0edb.jpg",
        "metaData": {
          "secondaryField": null
        },
        "profileUrl": "http://devaddons1.socialengineaddons.com/mobiledemodevelopment/profile/AntonisChatzipetrou",
        "isOnline": false,
        "notification": true,
        "lastSeen": "2020-01-10T13:44:36.000Z"
      }
    },
    {
      "id": "89c7e352-4265-11ea-9c07-831a487bf6af",
      "userId": "18714",
      "isAdmin": false,
      "user": {
        "id": "18714",
        "displayName": "alle cavallaro",
        "profileImageUrl": "http://sample-file-url/mediea/10263_dd51.jpg",
        "metaData": {
          "secondaryField": null
        },
        "profileUrl": "http://devaddons1.socialengineaddons.com/mobiledemodevelopment/profile/AlleCavallaro",
        "isOnline": false,
        "notification": true,
        "lastSeen": "2020-01-10T13:44:36.000Z"
      }
    }
  ]
}

Get Conversation Count

Retrieves the total number of conversations of a user.

GET https://api.channelize.io/v2/conversations/count

Query Params

This table lists all parameters this API request supports to get filtered results.

Parameter	Type	Required	Default	Description
ids	string	no	null	Search the conversations with conversation IDs separated by commas.
isGroup	boolean	no	null	Restricts the search scope to only retrieve private 1-to-1 or group conversations. Allowed values are true and false. By default, all the conversations are retrieved.
type	string	no	null	Specifies the type of conversation. Allowed values are private and public. By default, all the conversations are retrieved.
customTypes	string	no	null	Specifies a comma-separated string of one or more custom types to filter the conversations.
search	string	no	null	Specifies the name of the conversation to retrieve.
membersIncluded	string	no	null	Specifies a comma-separated string of one or more user IDs to restrict search scope. Example: user_id_1, user_id_2.
membersExactly	string	no	null	Searches for conversations with the specified members exactly in. The string should contain comma-separated multiple user IDs Example: user_id_1, user_id_2.
includeDeleted	boolean	no	false	Determines whether to include deleted conversation in response.
includeOnlyActive	string	no	false	Restricts the search scope to retrieve only conversations in which the user is active.
publicMode	boolean	no	false	Retrieves public conversation that the logged-in user is not a part of. This parameter only works when the type is set to the public.

Request Example

https://api.channelize.io/v2/conversations/count

Response

Status Code: 200

{
  "count": 162
}

Get Members

Retrieves the list of users who are members of the conversation.

GET https://api.channelize.io/v2/conversations/{conversation_id}/members

Path Params

This table lists all parameters this API request supports.

Parameter	Type	Required	Default	Description
conversation_id	string	yes	-	The unique ID of the conversation.

Request Example

https://api.channelize.io/v2/conversations/42ab4d40-666a-11e9-bdcd-0bf68210bf49/members

Response

Status Code: 200

[
  {
    "id": "89c7e350-4265-11ea-9c07-831a487bf6af",
    "userId": "18646",
    "isAdmin": true,
    "user": {
      "id": "18646",
      "displayName": "alex de bougex",
      "profileImageUrl": "https://sample-file-url/media/ff29_078f.jpg",
      "metaData": {
          "secondaryField": null
      },
      "profileUrl": "http://devaddons1.socialengineaddons.com/mobiledemodevelopment/profile/alx2bgx",
      "isOnline": false,
      "notification": true,
      "lastSeen": "2020-01-10T13:44:36.000Z"
    }
  },
  {
    "id": "89c7e351-4265-11ea-9c07-831a487bf6af",
    "userId": "18664",
    "isAdmin": false,
    "user": {
      "id": "18664",
      "displayName": "antonis chatzipetrou",
      "profileImageUrl": "http://sample-file-url/media/fff4_0edb.jpg",
      "metaData": {
        "secondaryField": null
      },
      "profileUrl": "http://devaddons1.socialengineaddons.com/mobiledemodevelopment/profile/AntonisChatzipetrou",
      "isOnline": false,
      "notification": true,
      "lastSeen": "2020-01-10T13:44:36.000Z"
    }
  },
  {
    "id": "89c7e352-4265-11ea-9c07-831a487bf6af",
    "userId": "18714",
    "isAdmin": false,
    "user": {
      "id": "18714",
      "displayName": "alle cavallaro",
      "profileImageUrl": "http://sample-file-url/mediea/10263_dd51.jpg",
      "metaData": {
        "secondaryField": null
      },
      "profileUrl": "http://devaddons1.socialengineaddons.com/mobiledemodevelopment/profile/AlleCavallaro",
      "isOnline": false,
      "notification": true,
      "lastSeen": "2020-01-10T13:44:36.000Z"
    }
  }
]

Get Watchers

Retrieves the list of users who are watchers of the conversation. A watcher refers to a user who has entered the conversation and is currently online.

GET https://api.channelize.io/v2/conversations/{conversation_id}/watchers

Path Params

This table lists all parameters this API request supports.

Parameter	Type	Required	Default	Description
conversation_id	string	yes	-	The unique ID of the conversation.

Query Params

This table lists all parameters this API request supports to get filtered results.

Parameter	Type	Required	Default	Description
limit	int	no	25	Specifies the number of results to return.
skip	int	no	0	Specifies the number of results you want to skip from the beginning. (Useful in Pagination)

Request Example

https://api.channelize.io/v2/conversations/42ab4d40-666a-11e9-bdcd-0bf68210bf49/watchers?limit=25&skip=0

Response

Status Code: 200

[
    {
        "id": "18646",
        "displayName": "alex de bougex",
        "profileImageUrl": "https://sample-file-url/media/ff29_078f.jpg"
    },
    {
        "id": "18664",
        "displayName": "antonis chatzipetrou",
        "profileImageUrl": "http://sample-file-url/media/fff4_0edb.jpg"
    },
    {
        "id": "18714",
        "displayName": "alle cavallaro",
        "profileImageUrl": "http://sample-file-url/mediea/10263_dd51.jpg"
    }
]

Add Members

Adds a member to the conversation. Group conversation members with admin permission can perform this action.

POST https://api.channelize.io/v2/conversations/{conversation_id}/add_members

Path Params

This table lists all possible parameters this API request supports.

Parameter	Type	Required	Default	Description
conversation_id	string	yes	-	The unique ID of the conversation.

Body Parameters

This table lists all possible parameters body of this API request supports.

Parameter	Type	Required	Default	Description
members	array	yes	-	Specifies an array of user IDs to add to the conversation. E.g. ["20236", "20697", "19116"]

Response

Status Code: 204

No Content

Remove Members

Removes a member from the conversation. Group conversation members with admin permission can perform this action.

POST https://api.channelize.io/v2/conversations/{conversation_id}/remove_members

Path Params

This table lists all parameters this API request supports.

Parameter	Type	Required	Default	Description
conversation_id	string	yes	-	The unique ID of the conversation.

Body Params

This table lists all parameters this API request supports.

Parameter	Type	Required	Default	Description
members	array	yes	-	Specifies an array of user IDs to remove from the conversation. E.g. ["20236", "20697", "19116"]

Response

Status Code: 204

No Content

Add Admin

Grants group admin permission to a user. Only an existing member/participant of the group can be admin of the group conversation.

PUT https://api.channelize.io/v2/conversations/{conversation_id}/add_admin

Path Params

This table lists all parameters this API request supports.

Parameter	Type	Required	Default	Description
conversation_id	string	yes	-	The unique ID of the conversation.

Body Params

This table lists all parameters body of this API request supports.

Parameter	Type	Required	Default	Description
userId	string	yes	null	The unique ID of the user who is going to be the new group conversation admin.

Response

Status Code: 204

No Content

Remove Admin

Remove group admin permission from a user.

PUT https://api.channelize.io/v2/conversations/{conversation_id}/remove_admin

Path Params

This table lists all parameters this API request supports.

Parameter	Type	Required	Default	Description
conversation_id	string	yes	-	The unique ID of the conversation.

Body Params

This table lists all parameters body of this API request supports.

Parameter	Type	Required	Default	Description
userId	string	yes	null	The unique ID of the user who is going to be removed from group conversation admin role.

Response

Status Code: 204

No Content

Clear Conversation

Clears a targeted conversation. Clear conversation is allowed for private conversations only.

DELETE https://api.channelize.io/v2/conversations/{conversation_id}/clear

Path Params

This table lists all parameters this API request supports.

Parameter	Type	Required	Default	Description
conversation_id	string	yes	-	The unique ID of the conversation to clear.

Response

Status Code: 204

No Content

Delete Conversation

Deletes a targeted conversation. This API lets you delete the copy of a conversation for a user. For other members of the conversation, this conversation will still appear, and hence the conversation is not hard-deleted from the database.

DELETE https://api.channelize.io/v2/conversations/{conversation_id}/delete

Path Parameters

Parameter	Type	Required	Default	Description
conversation_id	string	yes	-	The unique ID of the conversation to delete.

Response Body

Status Code: 204

No Content

Join a Conversation

Joins the targeted conversation for a user. Join Conversation is allowed for public conversations only.

POST https://api.channelize.io/v2/conversations/{conversation_id}/join

Path Params

This table lists all parameters this API request supports.

Parameter	Type	Required	Default	Description
conversation_id	string	yes	-	The unique ID of the conversation to join.

Response

Status Code: 204

No Content

Leave a Conversation

Leaves the targeted conversation for a user.

POST https://api.channelize.io/v2/conversations/{conversation_id}/leave

Path Params

This table lists all parameters this API request supports.

Parameter	Type	Required	Default	Description
conversation_id	string	yes	-	The unique ID of the conversation to leave.

Response

Status Code: 204

No Content

Update Title

Updates the title of a group conversation. Group conversation members with admin permission can perform this action.

PUT https://api.channelize.io/v2/conversations/{conversation_id}/update_title

Path Params

This table lists all parameters this API request supports.

Parameter	Type	Required	Default	Description
conversation_id	string	yes	-	The unique ID of the conversation to update.

Body Params

This table lists all parameters body of this API request supports.

Parameter	Type	Required	Default	Description
title	string	yes	null	Specifies the title for the conversation.

Response

Status Code: 204

No Content

Update Profile Image

Updates the profile image of a group conversation. Group conversation members with admin permission can perform this action.

PUT https://api.channelize.io/v2/conversations/{conversation_id}/update_profile

Path Params

This table lists all parameters this API request supports.

Parameter	Type	Required	Default	Description
conversation_id	string	yes	-	The unique ID of the conversation to update.

Body Params

This table lists all parameters body of this API request supports.

Parameter	Type	Required	Default	Description
profileImageUrl	string	no	null	Specifies the profile image URL of the conversation.

Response

Status Code: 204

No Content

Update Settings

Updates the settings of a targeted conversation. These settings include mute conversation settings.

PUT https://api.channelize.io/v2/conversations/{conversation_id}/update_settings

Path Params

This table lists all parameters this API request supports.

Parameter	Type	Required	Default	Description
conversation_id	string	yes	-	The unique ID of the conversation.

Body Params

This table lists all parameters body of this API request supports.

Parameter	Type	Required	Default	Description
mute	boolean	yes	null	Determine whether you want to mute or unmute the conversation.

Response

Status Code: 204

No Content