Tasks

Update a Task Comment

Updates the text of a given comment on a task. A comment cannot be moved to another task.

Documentation: https://api.exhibitday.com/Help/V1?epf=2#patch-v1-tasks-comment

patch/v1/tasks/comment

Request

  • Base URL: https://api.exhibitday.com
  • URL: https://api.exhibitday.com/v1/tasks/comment
  • Auth: one of:
    • API key in header api_key
    • API key in query parameter api_key

Request body

idinteger required

The Id of the task comment you would like to update.

commentstring required

The text that will replace the existing comment, including any formatting previously applied in ExhibitDay. Only accepts plain text. Any HTML tags will be stripped. Newline characters are displayed as line breaks in ExhibitDay and remain newline characters in API responses. Accepts up to 15,000 characters (some symbols count as two characters). A comment cannot be blank: an empty value (or null) is rejected with an error.

Response

OK

status_codeinteger
statusstring nullable
messagestring nullable
errorsstring[] nullable
warningsstring[] nullable

Only when an empty value left a parameter unchanged (see the help page).

error_codestring nullable

Errors only: what kind of error this is. invalid_request (400): A parameter is missing or has an invalid value (error_params names it when the API can tell); malformed_json (400): The request body is not valid JSON; not_allowed (400): The change is not allowed for that record in ExhibitDay (e.g., the event's tasks or its deletion are locked, or its Misc. Expenses & Credits tab is hidden); idempotency_key_reused (400): The Idempotency-Key was already used with a different request. Use a new key for a new request; missing_api_key (401): No api_key was sent; invalid_api_key (401): The api_key is not valid; api_access_disabled (401): API access is not enabled for the workspace; not_found (404): No record with that id exists in your workspace; unknown_endpoint (404): The URL or HTTP method is not part of the API; idempotency_key_in_use (409): A request with the same Idempotency-Key is still being processed. Retry after a moment; idempotency_key_indeterminate (409): A previous request with this Idempotency-Key did not finish and its outcome is unknown, so this retry was not run (to avoid creating a duplicate). Check whether the earlier request succeeded; to try again, use a new Idempotency-Key; rate_limited (429): Too many requests. Wait the number of seconds in the Retry-After header, then retry; internal_error (500): An unexpected error occurred. Quote the request_id when you contact support. New codes may be added; handle an unknown code by its HTTP status.

error_paramsstring[] nullable

Errors only: the request parameters the errors refer to ([] when the API cannot tell).

request_idstring nullable

Errors only: this request's id, also in the X-Request-Id header. Quote it when you contact support.

Changes

No recorded changes to this operation across all 1 revision of this API.