Sign in

v1

latestOpenAPI 3.0.02026-07-24622596.0 KB
Photos

Add Comment

post/photos/{photo_id}/comments

Path parameters

photo_idstring id required

ID of the Photo

Headers

X-CompanyCam-Userstring

Email of CompanyCam user to be designated as the commenter

Request body

Response

The created photo comment

idstring required

The unique ID of the comment

creator_idstring

The id of the entity that created the Comment

creator_typestring

The type of the entity that created the Comment

creator_namestring

The display name of the entity that created the Comment

commentable_idstring

The unique ID of the entity that the comment was applied to

commentable_typestring

The type of the entity that the comment was applied to.

statusstring

This should always be active

contentstring

The contents of the comment. This may contain whitespace characters such as newlines.

created_atinteger

Timestamp when the Comment was created on the server

updated_atinteger

Timestamp when the Comment was last updated

Example response

{
  "id": "4782987471",
  "creator_id": "2789583992",
  "creator_type": "User",
  "creator_name": "Shawn Spencer",
  "commentable_id": "388472672",
  "commentable_type": "Photo",
  "status": "active",
  "content": "Have you seen this yet?",
  "created_at": 1152230608,
  "updated_at": 1152230400
}