TASK

Adds a new task.

POST/api/v2/tasks

Authentication

Choose one supported method for this request.

OAuth 2.0 client credentialsAPI key

Request body

application/jsonrequired

The task details to add.

userIDinteger · int32
companyIDinteger · int32
contactIDinteger · int32
relatedRecordIDinteger · int32
relatedRecordTypestringnullable
subRelatedRecordTypestringnullable
subRelatedRecordIDinteger · int32
subjectstringnullable
commentsstringnullable
dueDatestring · datenullable
dueDateStringstringnullable
statusstringnullable
prioritystringnullable
reminderboolean
reminderRepeatSchedulestring
utcReminderDatestring · date-timenullable
isFromLeadWorkflowbooleannullable

Responses

Task added successfully.

Standard response envelopeisSuccessmessageerrorsdata

Read the result from data. When isSuccess is false, errors lists what went wrong. Handling errors

taskIdinteger · int32
companyIdinteger · int32
companyNamestringnullable
userIdinteger · int32
ownerstringnullable
contactIdinteger · int32
contactstringnullable
relatedRecordIdinteger · int32
relatedRecordTypestringnullable
relatedTostringnullable
subjectstring
commentsstringnullable
dueDatestring · date
completeDatestring · date-timenullable
statusstringnullable
businessStepstring
prioritystringnullable
reminderboolean
reminderRepeatSchedulestring
utcReminderDatestring · date-timenullable
reminderDatestring · date-timenullable
createdstring · date-timenullable
lastModifiedstring · date-timenullable
enteredBystringnullable
modifiedBystringnullable
deletedboolean
eventIdstring
calendarIdstring

REQUEST EXAMPLE

curl --request POST \
  'https://apiv2.crmseries.com/api/v2/tasks' \
  --header 'Authorization: Bearer YOUR_ACCESS_TOKEN' \
  --header 'Content-Type: application/json' \
  --data '{
    "userID": 1024,
    "companyID": 1024,
    "contactID": 1024,
    "relatedRecordID": 1024,
    "relatedRecordType": "string",
    "subRelatedRecordType": "string",
    "subRelatedRecordID": 1024,
    "subject": "string",
    "comments": "string",
    "dueDate": "2026-01-15",
    "dueDateString": "string",
    "status": "string",
    "priority": "string",
    "reminder": true,
    "reminderRepeatSchedule": "string",
    "utcReminderDate": "2026-01-15T14:30:00Z",
    "isFromLeadWorkflow": true,
    "udfs": [
      {
        "fieldName": "string",
        "fieldValue": "string",
        "recordType": "string"
      }
    ]
  }'

Replace the uppercase placeholders and sample values with your integration values.

RESPONSE · 200

{
  "isSuccess": true,
  "message": "",
  "data": {
    "taskId": 1024,
    "companyId": 1024,
    "companyName": "Acme Equipment Co.",
    "userId": 1024,
    "owner": "string",
    "contactId": 1024,
    "contact": "string",
    "relatedRecordId": 1024,
    "relatedRecordType": "string",
    "relatedTo": "string",
    "subject": "string",
    "comments": "string",
    "dueDate": "2026-01-15",
    "completeDate": "2026-01-15T14:30:00Z",
    "status": "string",
    "businessStep": "string",
    "priority": "string",
    "reminder": true,
    "reminderRepeatSchedule": "string",
    "utcReminderDate": "2026-01-15T14:30:00Z",
    "reminderDate": "2026-01-15T14:30:00Z",
    "created": "2026-01-15T14:30:00Z",
    "lastModified": "2026-01-15T14:30:00Z",
    "enteredBy": "string",
    "modifiedBy": "string",
    "deleted": false,
    "eventId": "string",
    "calendarId": "string",
    "recordAccessRights": {
      "exists": true,
      "view": true,
      "edit": true,
      "delete": true,
      "addNote": true
    },
    "udfs": [
      {
        "udf": {
          "udfid": 1024,
          "recordType": "string",
          "categoryId": 1024,
          "subCategoryId": 1024,
          "category": "string",
          "categorySortOrder": 1,
          "subCategory": "string",
          "subCategorySortOrder": 1,
          "fieldName": "string",
          "displayText": "string",
          "dataType": "string",
          "editable": true,
          "visible": true,
          "required": true,
          "complete": true,
          "editCriteria": "string",
          "editRules": "string",
          "sortOrder": 1,
          "location": "string",
          "lastModified": "2026-01-15T14:30:00Z",
          "deleted": false
        },
        "lookups": [
          {
            "udflookupId": 1024,
            "udfid": 1024,
            "value": "string",
            "groupName": "string",
            "sortOrder": 1,
            "lastModified": "2026-01-15T14:30:00Z",
            "deleted": false
          }
        ],
        "assignedId": 1024,
        "udfid": 1024,
        "recordType": "string",
        "recordId": 1024,
        "lookupId": 1024,
        "stringValue": "string",
        "dateValue": "2026-01-15",
        "numericValue": 125000.5,
        "booleanValue": true,
        "entered": "2026-01-15T14:30:00Z",
        "lastModified": "2026-01-15T14:30:00Z"
      }
    ]
  },
  "errors": []
}