Delete a post

Table of Contents

Note:

  • Each time the zoho.connect.deletePost integration task is executed, it triggers an API request in the back-end. This call is deducted from the external calls limit available for the service from which the task is executed, based on your pricing plan.
  • Only actual executions that receive a response (whether success or failure) are counted, not the number of times the task appears in the script. For example, if zoho.connect.deletePost integration task is placed inside a for each task that iterates five times, the number of external calls consumed will be five, even though the task appears only once in the script. 

Overview

This task is used to delete a post added using the addPost task.

Syntax

<variable> = zoho.connect.deletePost(<scopeID>, <streamID>, <connectionName>);

where,

ParameterDescriptionData 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

Note:

In integration tasks, the parameters must be in the defined order as given in the syntax, for the Deluge task to be executed. If you choose to use an optional parameter, ensure that all preceding parameters in the syntax are explicitly specified. If a preceding optional parameter is not required, a null value can be assigned instead, to maintain the defined syntax order.

For example, in the below syntax, options_map and connection are optional parameters:

<variable> = zoho.crm.v8.task (<module_name>, <record_details>, <options_map>, <connection>);

If you want to use the connection parameter, module_name, record_details and options_map must be specified in the 
exact order as the syntax. You can assign an empty map to the options_map parameter if it is not required.

 

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,

postDetails
is a variable which will contain the returned response
105000017039001
is a value that represents the Scope ID of the network
105000210987123
is 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"}

Related Links