Tasks

Update a Task

To update a task, only pass in the properties that you want to update. To clear a property, pass in null; an empty value leaves the property unchanged (the warnings property in the response names any such parameters). If the update is successful, the message property in the response will contain a list of task properties that were actually changed.

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

patch/v1/tasks

Request

  • Base URL: https://api.exhibitday.com
  • URL: https://api.exhibitday.com/v1/tasks
  • 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 you would like to update.

namestring nullable

The name/short description of the task.

event_idinteger nullable

The id of the event you would like to move the task to. To make it a general task (one that is not under any event), pass in null. A moved task is placed at the top of its new task list and taken out of its task section; to place it under one of the new event's task sections, also pass in task_section_id. Links between the task and items of its previous event are removed. A task cannot be moved into or out of an event whose tasks are locked.

task_section_idinteger nullable

The id of the event task section that the task should be placed under. If you don't want to place/categorize the task under a specific event task section, pass in the value "null" for this parameter. Note: you can get a list of available Task Section Ids for a given event using the /v1/events/info endpoint.

is_completedboolean nullable

Boolean representing whether or not the task has been completed: true or false (also accepted: yes/no, 1/0, completed/incomplete). Any other value is rejected with an error.

due_datestring date nullable

Task due date in YYYY-MM-DD format. To remove the due date, pass in null (JSON null or the string "null"). Omit this parameter, or pass in an empty value, to leave the due date unchanged.

assignee_user_idstring nullable

The User Id of the user you would like to assign the task to. If you want the task to be unassigned, pass in the value "null" for this parameter. To get a list of all the User Ids in your workspace, use the /v1/references/users_and_resources API endpoint; users who can have tasks assigned to them will have their can_have_tasks_assigned property set to true.

detailsstring nullable

The details/description of the task. Send plain text: it is stored HTML-encoded and returned as HTML, so a < b comes back as a < b and each line break as <br/>. Details written in the web app editor come back as that editor rich-text HTML. To clear this field, pass in null (JSON null or the string "null").

integration_metadata_field_1string nullable

This is an integration-specific text field only accessible via the ExhibitDay API. This field can be used to store whatever metadata or information you'd like about a particular task. For example, you can use it to store the "external id" of the task (from another system you're integrating with). Or, you can use it to store the last sync timestamp. Note: when you retrieve a list of tasks (using the /v1/tasks endpoint), you can filter down the results by the value of this field.

integration_metadata_field_2string nullable

This is an integration-specific text field only accessible via the ExhibitDay API. This field can be used to store whatever metadata or information you'd like about a particular task. For example, you can use it to store the "external id" of the task (from another system you're integrating with). Or, you can use it to store the last sync timestamp. Note: when you retrieve a list of tasks (using the /v1/tasks endpoint), you can filter down the results by the value of this field.

integration_metadata_field_3string nullable

This is an integration-specific text field only accessible via the ExhibitDay API. This field can be used to store whatever metadata or information you'd like about a particular task. For example, you can use it to store the "external id" of the task (from another system you're integrating with). Or, you can use it to store the last sync timestamp. Note: when you retrieve a list of tasks (using the /v1/tasks endpoint), you can filter down the results by the value of this field.

integration_metadata_field_4string nullable

This is an integration-specific text field only accessible via the ExhibitDay API. This field can be used to store whatever metadata or information you'd like about a particular task. For example, you can use it to store the "external id" of the task (from another system you're integrating with). Or, you can use it to store the last sync timestamp. Note: when you retrieve a list of tasks (using the /v1/tasks endpoint), you can filter down the results by the value of this field.

integration_metadata_field_5string nullable

This is an integration-specific text field only accessible via the ExhibitDay API. This field can be used to store whatever metadata or information you'd like about a particular task. For example, you can use it to store the "external id" of the task (from another system you're integrating with). Or, you can use it to store the last sync timestamp. Note: when you retrieve a list of tasks (using the /v1/tasks endpoint), you can filter down the results by the value of this field.

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.