Tasks

Add a Task

The response will contain an object representing the newly added task.

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

post/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

Headers

Idempotency-Keystring

A unique value (e.g. a UUID) for this create. If you retry with the same key within 24 hours, you get the first response again instead of a second record. A 409 idempotency_key_in_use means the first request is still running (retry shortly with the same key); 409 idempotency_key_indeterminate means it never finished (check whether the record exists, then use a new key). The same key with a different request is refused with 400 idempotency_key_reused. A key is 1 to 255 visible ASCII characters, without spaces.

Request body

namestring required

The name/short description of the task.

event_idinteger

The id of the event you would like to add the task under. If this value is not provided, the task will be added as a general (non-event-specific) task in your workspace (under the main Task Board).

task_section_idinteger

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

is_completedboolean

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

Task due date (format: YYYY-MM-DD).

assignee_user_idstring

The id of the user you would like to assign the task to. If you want the task to be unassigned, leave the value for this parameter blank. To get a list of all the user ids in your workspace, use the /v1/references/users_and_resources API endpoint. Users that can have tasks assigned to them will have their can_have_tasks_assigned property set to true.

detailsstring

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.

integration_metadata_field_1string

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

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

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

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

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

idinteger
exhibitday_urlstring nullable
event_task_section_idinteger nullable
event_task_sectionstring nullable
display_rankinteger
namestring nullable
due_datestring nullable
is_completedboolean
task_completed_timestampstring date-time nullable
detailsstring nullable
task_created_timestampstring date-time
task_last_update_timestampstring date-time
integration_metadata_field_1string nullable
integration_metadata_field_2string nullable
integration_metadata_field_3string nullable
integration_metadata_field_4string nullable
integration_metadata_field_5string nullable

Changes

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