Skip to main content


Web services from /about to /webhooks

create comment url public

/comments/forurl [POST]


Create a new comment on a URL.

The URL does not have to exist in PageSeeder or even point to a valid resource but it must be a valid URL.

This service is useful to attach comments to a common anchor that can be queried when there is no URI or when it would cause too many comments to be posted on a group.


authornameThe name of the authoryesstring
contentThe content of the comment. XHTML content is sanitized.yesstring
groupsA comma-separated list of group names the comment should belong toyesstring
titleThe title of the commentyesstring
urlThe URL for the URI with optional #fragmentyesurl
assignedtoThe ID of the member to assign the task to – status MUST be setnolong
authoremailThe email address of the authornoemail
contenttypeThe media type of the commentnomediatypetext/plain 
dueThe task due date, format is ISO-8601 – status MUST be set e.g. 2010-10-25, 2010-10-25T12:26 (defaults to T18:00)nodate or datetime
labelsA comma-separated list of label valuesnostrings
notifyThe notification behaviornonotifynormal
notify-asyncWhether emails should be sent asynchronously (for slow email servers)nobooleanfalse
priorityThe priority for the task e.g. High, Medium, Low – status MUST be setnopriority
propertiesA pipe-separated list of value pairs (e.g. x=1|y=2|)nostring
statusThe task status value, e.g. Opennostatus
typeThe type of the commentnostring
urisComma-separated list of attachments as URI ID with optional !fragment e.g. 123,23,456!content,34!titlenolongs
urlsComma-separated list of attachments as URL with optional #fragmentnourls


The task due date can be either a date (for example 2010-10-25) or a date with a time component (for example 2010-10-25T12:26). When the time isn't specified, it defaults to 18:00.

The status MUST be set for the due date to be set.


The priority parameter must use a value that has been defined in the group properties.

For example: High, Medium, Low.

The status MUST be set for the priority to be set. 


The value must match a valid status as defined in Group Properties.

For example: Open, Resolved, Closed.

To process assignedto and priority parameters requires that status be specified.


This service is public, anyone can invoke it since the URL for the URI has public access.


The XML response wraps the created comment as <comment> inside a <comment-creation> element.

<comment-creation [notification-email-delayed="true"|
  <comment id="123"
    <title>Cavern stolen!</title>
    <author email="">
      <fullname>Ali Baba</fullname>
    <assignedto id="123" date="2012-03-09T..."> ... </assignedto>
    <modifiedby id="456" date="2012-03-09T..."> ... </modifiedby>
    <content id="789" type="text/plain">Sesame opened the door</content>
    <context fragment="2">
      <uri id="789"> ... </uri>
      <uri id="189"> ... </uri>
    <attachment fragment="5">
      <uri  id="289"> ... </uri>

Error Handling

CodeCause / Description
0x1002 Invalid email address
0x1301 If the author is missing
0x1302 If the author is existing and was specified using authorname or authoremail
0x1303 Both URI and URL have been specified
0x1304 The URL is invalid
0x1305 The URL does not match a GroupURI
0x1306 The Group is invalid
0x1307 The assigned to member is invalid
0x1308 The due date is invalid
0x6301 If the group has no general discussion
0x6302 Failed to create new comment
Created on , last edited on