Podio API Documentation
Comments: Add comment to object
Adds a new comment to the object of the given type and id, f.ex. item 1.
Usage
- PHP Client
-
PodioComment.php
PodioComment::create( $ref_type, $ref_id, $attributes = array() ); - Ruby Gem
-
comment.rb
Podio::Comment.create( commentable_type, commentable_id, attributes )
Parameters
- type*
- Required.
- id*
- Required.
- alert_invite
True if any mentioned user should be automatically invited to the workspace if the user does not have access to the object and access cannot be granted to the object.
Default value: false- hook
True if hooks should be executed for the change, false otherwise.
Default value: true- silent
If set to true, the object will not be bumped up in the stream and notifications will not be generated.
Default value: false
Request
{
"value": The comment to be made,
"external_id": The external id of the comment, if any,
"file_ids": Temporary files that have been uploaded and should be attached to this comment,
[
{file_id},
.... (more file ids)
],
"embed_id": [OPTIONAL] The id of an embedded link that has been created with the Add an mebed operation in the Embed area,
"embed_url": The url to be attached
}
Response
{
"comment_id": The id of the newly created comment,
"granted_users": The list of profiles of users that was granted access to the reference
[
{
"profile_id": The id of the profile,
... (more profile properties)
},
... (more profiles)
]
... (more properties, see the get comment operation)
}