Delete a post
Table of Contents
Overview
This task is used to delete a post added using the addPost task.
Syntax
<variable> = zoho.connect.deletePost(<scopeID>, <streamID>, <connectionName>);
where,
| Parameter | Description | Data type |
<variable> | is a variable which will hold the returned response. | KEY-VALUE |
<scopeID> | specifies the Scope ID of the network in which the post to be deleted exists. You can also fetch the scope ID from the response of myNetworks task. | NUMBER |
<streamID> | specifies the Stream ID of the post which will be deleted. You can fetch the stream ID from the response of addPost task. | NUMBER |
<connectionName> (optional) | is the name of the Zoho connect connection. *Note: This param is not applicable to Zoho Creator and mandatory in Zoho Cliq. | TEXT |
Example
The below example illustrates the deletion of a post using the Scope ID of the network, whose Stream ID is 105000210987123
postDetails = zoho.connect.deletePost(105000017039001, 105000210987123);
where,
postDetailsis a variable which will contain the returned response
105000017039001is a value that represents the Scope ID of the network
105000210987123is a value that represents the Stream ID of the post
Sample Response
- Following is the response when the post is successfully deleted:{"status":"success"}
- The response returned is null when the Scope ID supplied is incorrect
- The response below is obtained when an incorrect Stream ID is supplied{"reason":"This post has been deleted.",
"status":"failure"}