FIfieldpulse
Comments

Create a comment

Changed on
post/comments

Request

  • Base URL
    https://ywe3crmpll.execute-api.us-east-2.amazonaws.com/stage
  • URL
    https://ywe3crmpll.execute-api.us-east-2.amazonaws.com/stage/comments
  • Auth
    API key in header x-api-key

Request body

textstring required
commentable_idinteger required

The id of the entity (customer, job, etc .. ) for which belongs the comment.

commentable_typestring required

The entity (customer, job, etc .. ) for which belongs the comment.

Response

Created

errorboolean

false when the request succeeds.

responseobject

The created record.

Changes

  • ee9f1d863d51Revision changes
    • breaking

      added the new required request property

    • breaking

      added the new required request property

    • breaking

      added the new required request property

    • breaking

      removed the success response with the status

    • info

      added the success response with the status