Delete Work Order Comment

DELETE 
/organizations/:organizationId/work-orders/:workOrderId/comments/:commentId

Soft delete a comment on a work order. Users can only delete their own comments.

Request

Path Parameters

organizationId stringrequired

Organization ID

workOrderId stringrequired

Work Order ID

commentId stringrequired

Comment (Activity) ID

Responses

200

application/json

Schema

Schema

success booleanrequired

True if deletion was successful

message stringrequired

Success message

Example (from schema)

{
  "success": true,
  "message": "string"
}

Example

{}

401

The request has not permission.

application/json

Schema

Schema

error stringrequired

The request has not permission.

message stringrequired

The request has not permission message.

Example (from schema)

{
  "error": "string",
  "message": "string"
}

Example

{
  "error": "Unauthenticated",
  "message": "Authentication is required and has failed or has not yet been provided."
}

403

The request has not permission.

application/json

Schema

Schema

error stringrequired

The request has not permission.

message stringrequired

The request has not permission message.

Example (from schema)

{
  "error": "string",
  "message": "string"
}

Example

{
  "error": "Forbidden",
  "message": "Access to the requested resource is forbidden."
}

404

The resource hasn't found.

application/json

Schema

Schema

error stringrequired

The resource hasn't found.

message stringrequired

The resource hasn't found message.

Example (from schema)

{
  "error": "string",
  "message": "string"
}

Example

{
  "error": "ResourceNotFound",
  "message": "The requested resource could not be found."
}

Loading...