Choose where you’d like to start

Post to channel as admin

Table of Contents

Overview

This task is used to post a message as an admin to any of the channels that you are a part of, using the channel name in Zoho Cliq. The channel members will receive your message in the channel and the sender will be displayed as admin.

This task is based on Zoho Cliq API - Post message in a channel.

Syntax

<variable> = zoho.cliq.postToChannelAsAdmin(<channel_name>, <message>, <connection>);

where,

ParamsData typeDescription

<variable>

KEY-VALUE

is the variable which will hold the response returned by Zoho Cliq.

<channel_name>

TEXT

is the channel's name in which the message will be posted.

<message>

TEXT
KEY-VALUE
FILE
LIST of FILE

is the message to be posted.

The different types of content that can be posted in a channel can be found here.

<connection>

TEXT

specifies the link name of the Zoho Cliq connection.

Note:

  • In view of stopping new authtoken generation, a Zoho OAuth connection with appropriate scopes is mandatory for new integration tasks (created after the deadline specified in the post) to work as expected. Existing integration tasks will continue to work with or without the connections parameter unless the authtoken is manually deleted from accounts.
  • Add relevant scopes as mentioned in Zoho Cliq API - Post to channel.
  • Refer to this post for the list of Zoho services that support the connections page.
  • Learn more about connections

Example

The following script posts a message Hello as an admin in the channel - DelugeChannel.

response = zoho.cliq.postToChannelAsAdmin("DelugeChannel","Hello", "cliq_connection");

(or)

response = zoho.cliq.postToChannelAsAdmin("DelugeChannel",{"text":"Hello"}, "cliq_connection");

where,

response
is a KEY-VALUE response returned by Zoho Cliq, that represents the status of the executed task
"DelugeChannel"
is a TEXT that represents channel name
"text"
is the key of TEXT data type which represents the message to be posted
"Hello"
is the TEXT message to be posted
"cliq_connection"
is the TEXT that represents the name of the connection

Response Format

  • The following is a sample success response:

    {"status":"success"}

  • The failure response returned for a non-existent channel name is of the following format.

    {
    "message":"Whoa! Looks like this channel does not exist.",
    "code":"channel_not_exists"
    }

Related Links

Get Started Now

Execute