TABLE OF CONTENTS

• Parameters
• Example

ADDITIONAL INFO

• API Explorer

This request method allows you to create a new task and assign it to a specified user(s). On the Cloud, this API is available via SSL-secured HTTPS connection using the REST POST verb. The format query string parameter controls the desired response format. Specify either XML or JSON.

/api/v2/task?format=xml/json

You may use either JSON or XML formats in your POST submission. You indicate this by setting the ContentType HTTP header as "application/json" or "application/xml". If no ContentType is specified, XML format is assumed.

All XML formatted requests must specify the following XML namespace in the data source root element:
xmlns:i="http://www.w3.org/2001/XMLSchema-instance"

Parameters

The POST verb allows you to create a new task and send that task to a specified user.
The required and optional parameters for a POST call to the Task API are outlined below.

✓* - At least one of these values is required.

Example

Given that the API is REST-based, you can access the API directly via your web browser to test or by using Postman API Platform.

Request URL

https://secure.formsonfire.com:443/api/v2/task

{
  "UserEmail": "[email protected]",
  "Name": "This is a test task",
  "CompleteBy": "2023-09-27 18:00:00",
  "StartBy": "2023-09-26 18:00:00",
  "IsAllDay": false,
  "AllDayUtcOffset": 0,
  "AllDayDate": "Date",
  "CompleteAtText": "",
  "CompleteAtLat": 0,
  "CompleteAtLon": 0,
  "PerformWithin": 0,
  "AdditionalInfo": "This is a test task description.",
  "DisableNotes": false,
  "SendImmediate": true,
  "UserCanReject": false,
  "RestrictToGroup": "",
  "UserCanReassign": true,
  "ReassignType": "",
  "TargetGroup": "",
  "Activities": [
    {
      "Name": "The App To Open",
      "FormExternalId": "ext_id_form_to_open",
    }
  ],
  "ValidateFormAnswers": false,
  "RetrieveEntries": false,
  "MediaAsUrl": false,
  "AnswerFormat": "",
  "PurgeDays": 0,
  "CompanyId": 6XXXX,
  "IntegrationKey": "995XXXXXXXXXXXXXXXXXXXXXXXX"
}