Task

An object that represents a task, call, message, or todo.

Supported API Calls: Get | Add | Update | Delete

Object Properties

Property

Type

Description

ID

integer

Unique identity of a Task object. When adding a new Task object the value must be 0.

DurationInSeconds

double

An optional value. If this task is defined in a project template (a task's Time To Complete Task field), this value sets duration in seconds. This value is optional.

Subject

string (100)

The task's subject.

DependTask

string (100)

If this is a project task, the task this task is dependent on.

Description

string (100)

The task's description field.

IsReminderSet

boolean

Flag to indicate this task should generate a reminder.

OwnerId

integer

The ID of the user who owns this task object.

Owner

string (100)

Name of the task owner.

ReminderDate

DateTime

Optional value. The date the reminder should be sent.

Priority

string (100)

Sets the task dialog box's Priority field. Values are Low, Normal, High.

Status

string (100)

Sets the task dialog box's Status field. Values are: Not Started, In Progress, Completed.

ParentId

integer

If this task is the child of an object (a task under a lead, a task under a project, etc.), enter the ID of the parent object. This value is optional.

ParentObject

string (100)

ParentObject identifies what kind of object the task object is a child of. Values are lead, account (if it's an organization), contact, opportunity, project, case

StartDate

DateTime

Optional. The date the task should start.

DueDate

DateTime

Optional. The date the task is due.

TaskType

string (100)

Determines what kind of task this is. Values are task, call, message, todo

IsClosed

boolean

Flag indicates the task is closed.

IsLocked

boolean

Flag indicates the task is locked and can't be edited. This property is read only

CreationDate

DateTime

Indicates when this object was created.

LastModifiedBy

integer

ID of the user who last modified the object.

LastModifiedDate

DateTime

Date the last time the object was modified.

IsRecurrence

boolean

Flag that indicates the event is repeating.

RecurrenceType

string (100)

Type of repeating event. Possible values are: daily, weekly, monthly, yearly.

RecurrenceInterval

integer

The number of repeats.

RecurrenceEndDate

DateTime

Date the recurrence should end.

AssigneeName

string(100)

Name of the user assigned the task.

Response

string(100)

Values are accepted or rejected.

Response

string(100)

Values are accepted or rejected.

ReminderTime

integer

Time in minutes until a reminder will be sent out.

OverDue

string (100)

Number of days the task is overdue. Example value "overdue|xDayLate|8". The task is 8 days overdue.

DependencyList

List<TaskDependency>

A list of dependencies for this task, if the task is part of a project.

CallContact

TaskCallContact

An object representing a called contact.

AttachmentList

List<AttachmentAssociate>

A list of any attachment objects.

TaskUser

TaskUser

An object representing the user assigned the task.

Notify

boolean

Flag to indicate assigned users should be notified the task has been assigned.

RelatedParentId

integer

ID of the object it is related to.

RelatedParentObject

string(100)

Related object type (project, person, organization, etc.)

Get

Description

Returns the task specified by the passed id.

URL

https://{company}.bluecamroo.com/api/task/get/{id}

HTTP Method

GET

Parameters

None

Data Return

Returns the task object in the requested format (e.g., JSON or XML)

HTTP Return Status Code

200: Ok

400: Bad Request (One or more input data items is not valid, for example a mandatory field is blank)

401: Not authorized (you need to log in)

403: Forbidden (you don't have permission to this resource)

Add

Description

Adds the task to the list of tasks.

URL

https://{company}.bluecamroo.com/api/task/add

HTTP Method

POST

Parameters

A task object

Data Return

Returns the task object in the requested format (e.g., JSON or XML)

HTTP Return Status Code

201: Created

401: Not authorized (you need to log in)

403: Forbidden (you don't have permission to this resource)

Update

Description

Updates a specified task.

URL

https://{company}.bluecamroo.com/api/task/update

HTTP Method

PUT

Parameters

A task object

Data Return

Returns the task object in the requested format (e.g., JSON or XML)

HTTP Return Status Code

200: Ok

400: Bad Request (One or more input data items is not valid, for example a mandatory field is blank)

401: Not authorized (you need to log in)

403: Forbidden (you don't have permission to this resource)

Delete

Description

Deletes the specified task.

URL

https://{company}.bluecamroo.com/api/task/delete/{id}

HTTP Method

DELETE

Parameters

None

Data Return

None

HTTP Return Status Code

200: Ok

400: Bad Request (One or more input data items is not valid, for example a mandatory field is blank)

401: Not authorized (you need to log in)

403: Forbidden (you don't have permission to this resource)