Choose where you’d like to start

Get post using Third Party Id

Overview

This task can be used to retrieve a post details using the tpEntityID param. The tpEntityID param can be initially specified while creating a post using the addPost task, and that post can retrieved using the current task, based on the specified tpEntityID.

Syntax

<variable> = zoho.connect.getPostByTpId(<scopeID>, <tpEntityID>, <connectionName>);

where,

ParameterDescriptionData type

<variable>

is the variable which will hold the returned resonse.

The response will contain the meta details, entity id and other information related to the third party message.

KEY-VALUE

<scopeID>

is the variable which represents the Scope ID of the network in which the post exists.

You can also fetch the scope ID from the response of myNetworks task.

NUMBER

<tpEntityID>

is the variable which represents the value of the tpEnitityID param used while creating the post.

TEXT

<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 example below illustrates how a third party message with a tpEntityId (third party ID) can be used to retrieve it's contents

postDetails = zoho.connect.getPostByTpId(105000017039001, "TPEnt001");

where,

postDetails
is a variable that holds the third party message and related information
105000017039001
is a value that represents the Scope ID of the network
105000210839094
is a value that represents the tpEntityId of the third party message

Sample Response

  • Following is a sample success response:
{"posts":
["{\"tpMetaDetails\":{},
\"partitionId\":\"105000207776500\",
\"plainContent\":\"TP Comment\",
\"networkName\":\"Trading Corporation\",
\"richContent\":\"TP Comment\",
\"isPrivate\":\"false\",
\"title\":\"\",
\"partitionType\":\"2\",
\"url\":\"https://connect.zoho.com/portal/intranet/stream/10500021086412\",
\"partitionName\":\"Test Group\",
\"createdBy\":
{\"profileUrl\":\"https://connect.zoho.com/portal/intranet/profile/664841234\",
\"isBot\":\"false\",
\"isGuest\":\"false\",
\"imageUrl\":\"https://contacts.zoho.com/file?t=user&ID=664841234&fs=thumb\",
\"name\":\"testuser\",
\"timeZone\":\"Asia/Kolkata\",
\"language\":\"en\",
\"emailId\":\"testuser@zohocorp.com\",
\"id\":\"664841234\"},
\"createdTime\":\"2018-05-10T08:50+0000\",
\"attachmentCount\":\"0\",
\"networkId\":\"105000017039123\",
\"id\":\"105000210868396\",
\"tpEntityId\":\"TPEnt001\"
}"]
}
 
  • The response returned is null when the Scope ID supplied is incorrect
  • The below response returned when the third party Entity Id supplied is incorrect

{"posts":[]}

Related Links

Get Started Now

Execute