Prospero API

Comments

Endpoint:https://api.prosperoapp.com

Comments allow you to communicate with other Users within the context of a specific Prospero entity.

Comments can currently only be attached to Events.

List unresolved Comments

GET

https://api.prosperoapp.com

/comments

Returns a list of all unresolved Comments in your Organization.

List unresolved Comments › Responses

A list of Comments.

commentsobject[]

Create a Comment

POST

https://api.prosperoapp.com

/comments

Creates a Comment based on the provided fields.

Creating a Comment will automatically subscribe you to the Event it is attached to. If a User is @ mentioned in the Comment, that User will be automatically subscribed to the Event the Comment is attached to.

Creating a Comment will automatically create a Notification for each User that is subscribed to the Event it is attached to, except for the User that created the Comment.

Create a Comment › Request Body

orgIdstring · uuid
The id of the Organization that owns this Comment.
regardingobject
Information about the entity this Comment is attached to.
bodystring · html
The content of the Comment. Supports basic HTML tags and formatting.

Create a Comment › Responses

The newly created Comment.

commentobject

List Comments of an Event

GET

https://api.prosperoapp.com

/comments/event/{eventId}

Returns a list of all Comments attached to the specified Event.

List Comments of an Event › path Parameters

eventIdstring · uuid · required
The id of the Event.

List Comments of an Event › Responses

A list of Comments attached to the specified Event.

commentsobject[]

Retrieve a Comment

GET

https://api.prosperoapp.com

/comments/{commentId}

Retrieves the Comment with the given id.

Retrieve a Comment › path Parameters

commentIdstring · uuid · required
The id of the Comment.

Retrieve a Comment › Responses

The requested Comment.

commentobject

Delete a Comment

DELETE

https://api.prosperoapp.com

/comments/{commentId}

Deletes the specified Comment. Archived Comments cannot be deleted.

Delete a Comment › path Parameters

commentIdstring · uuid · required
The id of the Comment.

Delete a Comment › Responses

The Comment was successfully deleted.

No data returned

Update a Comment

PATCH

https://api.prosperoapp.com

/comments/{commentId}

Updates the specified Comment by setting the values of the fields passed. Any fields not provided will be left unchanged. By design, you cannot change a Comment's id or the entity it is attached to.

If a User is newly @ mentioned in the Comment, that User will be automatically subscribed to the Event the Comment is attached to. Notifications will be automatically created for those Users.

Update a Comment › path Parameters

commentIdstring · uuid · required
The id of the Comment.

Update a Comment › Request Body

idstring · uuid · readOnly
The globally unique identifier of this entity. Prospero uses v1 UUIDs.
createdAtstring · date-time · readOnly
An ISO 8601-compliant datetime string, formatted YYYY-MM-DDThh:mm:ssZ.
lastUpdatedAtstring · date-time · readOnly
An ISO 8601-compliant datetime string, formatted YYYY-MM-DDThh:mm:ssZ.
orgIdstring · uuid · readOnly
The id of the Organization that owns this Comment.
archivedboolean · readOnly
Whether this Comment has been archived.
regardingobject · readOnly
Information about the entity this Comment is attached to.
userIdstring · uuid · readOnly
The id of the User that created this Comment.
bodystring · html
The content of the Comment. Supports basic HTML tags and formatting.
resolvedboolean
Whether this Comment has been resolved.
resolvedByIdstring · uuid
If applicable, the id of the User that resolved this Comment. Absent if the Comment is unresolved.

Update a Comment › Responses

The updated Comment.

commentobject

Events Notifications

Prospero API

Comments

Endpoint:https://api.prosperoapp.com

Comments allow you to communicate with other Users within the context of a specific Prospero entity.

Comments can currently only be attached to Events.

List unresolved Comments

GET

https://api.prosperoapp.com

/comments

Returns a list of all unresolved Comments in your Organization.

List unresolved Comments › Responses

A list of Comments.

commentsobject[]

Create a Comment

POST

https://api.prosperoapp.com

/comments

Creates a Comment based on the provided fields.

Creating a Comment will automatically create a Notification for each User that is subscribed to the Event it is attached to, except for the User that created the Comment.

Create a Comment › Request Body

orgIdstring · uuid
The id of the Organization that owns this Comment.
regardingobject
Information about the entity this Comment is attached to.
bodystring · html
The content of the Comment. Supports basic HTML tags and formatting.

Create a Comment › Responses

The newly created Comment.

commentobject

List Comments of an Event

GET

https://api.prosperoapp.com

/comments/event/{eventId}

Returns a list of all Comments attached to the specified Event.

List Comments of an Event › path Parameters

eventIdstring · uuid · required
The id of the Event.

List Comments of an Event › Responses

A list of Comments attached to the specified Event.

commentsobject[]

Retrieve a Comment

GET

https://api.prosperoapp.com

/comments/{commentId}

Retrieves the Comment with the given id.

Retrieve a Comment › path Parameters

commentIdstring · uuid · required
The id of the Comment.

Retrieve a Comment › Responses

The requested Comment.

commentobject

Delete a Comment

DELETE

https://api.prosperoapp.com

/comments/{commentId}

Deletes the specified Comment. Archived Comments cannot be deleted.

Delete a Comment › path Parameters

commentIdstring · uuid · required
The id of the Comment.

Delete a Comment › Responses

The Comment was successfully deleted.

No data returned

Update a Comment

PATCH

https://api.prosperoapp.com

/comments/{commentId}

Update a Comment › path Parameters

commentIdstring · uuid · required
The id of the Comment.

Update a Comment › Request Body

idstring · uuid · readOnly
The globally unique identifier of this entity. Prospero uses v1 UUIDs.
createdAtstring · date-time · readOnly
An ISO 8601-compliant datetime string, formatted YYYY-MM-DDThh:mm:ssZ.
lastUpdatedAtstring · date-time · readOnly
An ISO 8601-compliant datetime string, formatted YYYY-MM-DDThh:mm:ssZ.
orgIdstring · uuid · readOnly
The id of the Organization that owns this Comment.
archivedboolean · readOnly
Whether this Comment has been archived.
regardingobject · readOnly
Information about the entity this Comment is attached to.
userIdstring · uuid · readOnly
The id of the User that created this Comment.
bodystring · html
The content of the Comment. Supports basic HTML tags and formatting.
resolvedboolean
Whether this Comment has been resolved.
resolvedByIdstring · uuid
If applicable, the id of the User that resolved this Comment. Absent if the Comment is unresolved.

Update a Comment › Responses

The updated Comment.

commentobject

Events Notifications