Search API documentation

Type to search the API docs.

Update Task Progress from Another Tool

When work moves forward in another tool (for example Jira, Asana or a help desk), mark the linked Task Completed, change its Assignee or Due Date, and add a comment.

Example use case

A Jira issue for the booth graphics is closed. Your integration marks the linked ExhibitDay Task Completed and adds a comment that names the issue.

What you'll end up with

The Task's new completion status, Assignee or Due Date, and a new comment on the Task.

Before you start

Have a workspace API key and a Task linked to your tool's record. Create Tasks from Forms, Tickets or Other Apps creates one. Save your tool's ID in integration_metadata_field_1 when you create it.

Good to know

Send only the fields you want to change. The revision check refuses your update if someone changed the Task since you read it.

At a glance

Time to try

About 10 minutes

Effect on your data

Updates records

Endpoints

5

The example marks one Task Completed. Steps 5 and 6 change a Task and add a comment. ExhibitDay sends the same emails as when someone makes these changes on the website.

How it works

  1. Find the Task by your tool's ID and read its current revision.
  2. Save the new status, Assignee or Due Date with that revision. A conflict saves nothing.
  3. Add a comment, then read the Task again to confirm.

Update the linked Task

Step 1: Find the Task linked to your record

Search the integration field where you saved your tool's ID. This example looks for JIRA-4821.

curl -X GET "https://api.exhibitday.com/v1/tasks?filter_by_integration_metadata_field_1=JIRA-4821&%24return_task_lites=true" -H "Authorization: Bearer YOUR_API_KEY"

Example response (shortened)

{
  "records_found": 1,
  "total_records": 1,
  "has_more": false,
  "list_data": [
    {
      "id": 12345,
      "name": "Sample task",
      "is_completed": false,
      "integration_metadata_field_1": ""
    }
  ]
}

Check: Expect exactly one match. The filter matches the whole value and ignores letter case and spaces before or after it. If you kept the Task id when you created it, skip this step.

Step 2: Read the Task and its revision

Read the current values so the update can detect changes made since your read.

curl -X GET "https://api.exhibitday.com/v1/tasks/info?id=34567&%24include_record_revision=true" -H "Authorization: Bearer YOUR_API_KEY"

Check: Keep record_revision exactly as returned. If is_completed already has the value you want, there's nothing to save.

Step 3: Mark the Task Completed

Send is_completed with expected_revision set to the record_revision from Step 2, in place of YOUR_RECORD_REVISION. Send false to reopen a Completed Task (mark it Incomplete).

curl -X PATCH "https://api.exhibitday.com/v1/tasks" -H "Authorization: Bearer YOUR_API_KEY" -H "Content-Type: application/json" -d "{\"id\":34567,\"is_completed\":true,\"expected_revision\":\"YOUR_RECORD_REVISION\"}"

Example response (shortened)

{
  "status_code": 200,
  "status": "OK",
  "message": "Task Update Successful. Task properties that were changed: is_completed"
}

Check: message lists the Task properties that changed. If you get record_changed (HTTP 409), the update saved nothing. Read the Task again and decide whether your change is still needed.

Step 4: Confirm the new Assignee, if you change it

List the people who can be assigned Tasks. Tasks can't be assigned to Resources.

curl -X GET "https://api.exhibitday.com/v1/references/users_and_resources?filter_by_can_have_tasks_assigned=true" -H "Authorization: Bearer YOUR_API_KEY"

Example response (shortened)

{
  "list_data": [
    {
      "id": "11111111-2222-4333-8444-555555555555",
      "display_name": "Jane Smith",
      "can_have_tasks_assigned": true
    }
  ]
}

Check: The new Assignee's id appears in list_data. Treat the ID as text.

Step 5: Reassign the Task or move its Due Date

Use the same request with the fields you want to change. Leave out a field to keep it. Send expected_revision from a fresh read, because the Task's revision changed in Step 3.

curl -X PATCH "https://api.exhibitday.com/v1/tasks" -H "Authorization: Bearer YOUR_API_KEY" -H "Content-Type: application/json" -d "{\"id\":34567,\"assignee_user_id\":\"11111111-2222-4333-8444-555555555555\",\"due_date\":\"2027-03-05\",\"expected_revision\":\"YOUR_RECORD_REVISION\"}"
ToSend
Assign someone elseassignee_user_id with their user ID
Unassign the Taskassignee_user_id with null
Change the Due Datedue_date as YYYY-MM-DD
Remove the Due Datedue_date with null

Check: An empty value leaves the field as it is, and the response's warnings list names it. Assigning someone who can't be assigned Tasks, such as a Resource, returns invalid_request (HTTP 400).

Step 6: Add a comment

Post a short note in plain text. Add the header Idempotency-Key: YOUR_UNIQUE_KEY so a retry can reuse the original result.

curl -X POST "https://api.exhibitday.com/v1/tasks/comments" -H "Authorization: Bearer YOUR_API_KEY" -H "Content-Type: application/json" -d "{\"task_id\":34567,\"comment\":\"Closed in Jira: JIRA-4821\"}"

Example response (shortened)

{
  "id": 23456,
  "comment": "Closed in Jira: JIRA-4821",
  "task_id": 34567
}

Check: Save the comment id. Line breaks show as line breaks in ExhibitDay. To confirm the Task's saved values, read it again as in Step 2.

Try it

Before running the example

ValueWhat to put in it
YOUR_API_KEYYour workspace API key. Keep it out of shared code and logs.
idThe ID of a test Task, from Step 1. The example uses 34567.
is_completedtrue to mark the Task Completed, or false to mark it Incomplete. The example sends true.
expected_revisionReplace YOUR_RECORD_REVISION with the record_revision from Step 2. Leave it out to skip the revision check.

Copy the complete example in your language and run it. To try another step, change the request to match one of the steps above.

Complete example program

Code Samples
curl -X PATCH "https://api.exhibitday.com/v1/tasks" -H "Authorization: Bearer YOUR_API_KEY" -H "Content-Type: application/json" -d "{\"id\":34567,\"is_completed\":true,\"expected_revision\":\"YOUR_RECORD_REVISION\"}"

Example response

{
  "status_code": 200,
  "status": "OK",
  "message": "Task Update Successful. Task properties that were changed: is_completed",
  "errors": []
}
Note: PATCH /v1/tasks - HTTP 200. The Task was marked Completed. The message names the properties that changed. With expected_revision, the live response also returns the Task's new record_revision.

The curl example uses Bash. Node.js needs version 18 or later (save as .mjs). Python uses Requests. C# needs a .NET 8 console project (Program.cs). Java needs Java 11 or later (ExhibitDayExample.java). PHP needs PHP with cURL. Ruby and Go use their standard libraries.

Things to keep in mind

  • The API sends the same emails as the website. Completing a Task emails its Creator, Assignee and Contributors. Assigning it emails the new Assignee. A comment emails the Creator, Assignee and Contributors. Each person gets these only if their email preferences allow it, and the person who made the change doesn't get one.
  • If the Event's lock settings include “Also prevent this event's tasks from being modified outside the event, via the main Task Board” (under Lock the Tasks tab in Lock Event), the API returns not_allowed for its Tasks. Change that setting in ExhibitDay before you retry.
  • If you lose the comment's response, retry the exact request with the same key. For 24 hours, a completed request can return the saved response with Idempotent-Replayed: true.
  • If the API returns idempotency_key_indeterminate, list the Task's comments with GET /v1/tasks/comments and filter_by_task_id before deciding whether to post again.
  • More than one Task can share an integration value. Stop and check if Step 1 returns more than one.