Merge CRM - Tasks

Tasks

The Task object is used to represent a task, such as a to-do item.

Properties

idUUID

Required

remote_idString

Optional

The third-party API ID of the matching object.

created_atDateTime (ISO 8601)

Required

The datetime that this object was created by Merge.

modified_atDateTime (ISO 8601)

Required

The datetime that this object was modified by Merge.

subjectString

Optional

The task's subject.

contentString

Optional

The task's content.

ownerUUID

Optional

The task's owner.

accountUUID

Optional

The task's account.

opportunityUUID

Optional

The task's opportunity.

completed_dateDateTime (ISO 8601)

Optional

When the task is completed.

due_dateDateTime (ISO 8601)

Optional

When the task is due.

statusEnum

Optional

The task's status. Possible values include: OPEN, CLOSED. In cases where there is no clear mapping, the original value passed through will be returned. To receive all enum values in the original format, use the show_enum_origins query parameter. Learn more.

remote_was_deletedBoolean

Required

Indicates whether or not this object has been deleted in the third party platform. Full coverage deletion detection is a premium add-on. Native deletion detection is offered for free with limited coverage. Learn more.

field_mappingsObject

Optional

remote_dataRemoteData[]

Optional

remote_fieldsRemoteField[]

Required

GET

/tasks

https://api.merge.dev/api/crm/v1/tasks

APAC

Returns a list of Task objects.

Query & Path Parameters

created_afterDateTime (ISO 8601)

Optional

If provided, will only return objects created after this datetime.

created_beforeDateTime (ISO 8601)

Optional

If provided, will only return objects created before this datetime.

cursorString

Optional

The pagination cursor value.

expandString

Optional

Which relations should be returned in expanded form. Multiple relation names should be comma separated without spaces.

include_deleted_dataBoolean

Optional

include_remote_dataBoolean

Optional

Whether to include the original data Merge fetched from the third-party to produce these models.

include_remote_fieldsBoolean

Optional

Whether to include all remote fields, including fields that Merge did not map to common models, in a normalized format.

include_shell_dataBoolean

Optional

Whether to include shell records. Shell records are empty records (they may contain some metadata but all other fields are null).

modified_afterDateTime (ISO 8601)

Optional

If provided, only objects synced by Merge after this date time will be returned.

modified_beforeDateTime (ISO 8601)

Optional

If provided, only objects synced by Merge before this date time will be returned.

page_sizeInteger

Optional

Number of results to return per page.

remote_idString

Optional

The API provider's ID for the given object.

Field support by integration

See all supported fields

Use the /linked-accounts endpoint to pull platform support information

Accelo

Capsule

Copper

HubSpot

Insightly

Keap

Microsoft Dynamics 365 Sales

Nutshell

Pipedrive

Salesflare

Salesforce

SugarCRM

Teamleader

Teamwork CRM

Zendesk Sell

Zoho CRM

POST

/tasks

https://api.merge.dev/api/crm/v1/tasks

APAC

Creates a Task object with the given values.

Query & Path Parameters

is_debug_modeBoolean

Optional

Whether to include debug fields (such as log file links) in the response.

run_asyncBoolean

Optional

Whether or not third-party updates should be run asynchronously.

Body Parameters

modelObject

Required

Find available fields below under “Model Parameters”.

Model Parameters

View app-specific writable fields under “Field support by platform” in this section.

subjectString

The task's subject.

contentString

The task's content.

ownerUUID

The task's owner. Must pass in a valid Merge ID, which can be obtained from the id field in the User object.

accountUUID

The task's account. Must pass in a valid Merge ID, which can be obtained from the id field in the Account object.

opportunityUUID

The task's opportunity. Must pass in a valid Merge ID, which can be obtained from the id field in the Opportunity object.

completed_dateDateTime (ISO 8601)

When the task is completed.

due_dateDateTime (ISO 8601)

When the task is due.

statusEnum

The task's status. Must pass in one of the following choices: OPEN, CLOSED.

integration_paramsObject

linked_account_paramsObject

remote_fieldsArray

Field support by integration

See all supported fields

Use the /linked-accounts endpoint to pull platform support information

HubSpot

Pipedrive

Salesforce

Not seeing an integration that you're looking for? Submit a request for it.

To include the correct model fields when making POST requests, use the GET /tasks/meta/post endpoint. Learn more in our /meta guide.

GET

/tasks/{id}

https://api.merge.dev/api/crm/v1/tasks/{id}

APAC

Returns a Task object with the given id.

Query & Path Parameters

expandString

Optional

Which relations should be returned in expanded form. Multiple relation names should be comma separated without spaces.

idUUID

Required

include_remote_dataBoolean

Optional

Whether to include the original data Merge fetched from the third-party to produce these models.

include_remote_fieldsBoolean

Optional

Whether to include all remote fields, including fields that Merge did not map to common models, in a normalized format.

Field support by integration

See all supported fields

Use the /linked-accounts endpoint to pull platform support information

Accelo

Capsule

Copper

HubSpot

Insightly

Keap

Microsoft Dynamics 365 Sales

Nutshell

Pipedrive

Salesflare

Salesforce

SugarCRM

Teamleader

Teamwork CRM

Zendesk Sell

Zoho CRM

PATCH

/tasks/{id}

https://api.merge.dev/api/crm/v1/tasks/{id}

APAC

Updates a Task object with the given id.

Query & Path Parameters

idUUID

Required

is_debug_modeBoolean

Optional

Whether to include debug fields (such as log file links) in the response.

run_asyncBoolean

Optional

Whether or not third-party updates should be run asynchronously.

Body Parameters

modelObject

Required

Find available fields below under “Model Parameters”.

Model Parameters

View app-specific writable fields under “Field support by platform” in this section.

subjectString

The task's subject.

contentString

The task's content.

ownerUUID

The task's owner. Must pass in a valid Merge ID, which can be obtained from the id field in the Owner object.

accountUUID

The task's account. Must pass in a valid Merge ID, which can be obtained from the id field in the Account object.

opportunityUUID

The task's opportunity. Must pass in a valid Merge ID, which can be obtained from the id field in the Opportunity object.

completed_dateDateTime (ISO 8601)

When the task is completed.

due_dateDateTime (ISO 8601)

When the task is due.

statusEnum

The task's status. Must pass in one of the following choices: OPEN, CLOSED.

integration_paramsObject

linked_account_paramsObject

remote_fieldsArray

GET

/tasks/meta/patch/{id}

https://api.merge.dev/api/crm/v1/tasks/meta/patch/{id}

APAC

Returns metadata for Task PATCHs.

Query & Path Parameters

idUUID

Required

GET

/tasks/meta/post

https://api.merge.dev/api/crm/v1/tasks/meta/post

APAC

Returns metadata for Task POSTs.

Field support by integration

See all supported fields

Use the /linked-accounts endpoint to pull platform support information

HubSpot

Pipedrive

Salesforce

Not seeing an integration that you're looking for? Submit a request for it.

GET

/tasks/remote-field-classes

Beta

https://api.merge.dev/api/crm/v1/tasks/remote-field-classes

APAC

Returns a list of RemoteFieldClass objects.

Query & Path Parameters

cursorString

Optional

The pagination cursor value.

include_deleted_dataBoolean

Optional

include_remote_dataBoolean

Optional

Whether to include the original data Merge fetched from the third-party to produce these models.

include_remote_fieldsBoolean

Optional

Whether to include all remote fields, including fields that Merge did not map to common models, in a normalized format.

include_shell_dataBoolean

Optional

Whether to include shell records. Shell records are empty records (they may contain some metadata but all other fields are null).

is_common_model_fieldBoolean

Optional

If provided, will only return remote field classes with this is_common_model_field value

page_sizeInteger

Optional

Number of results to return per page.

Stages

Next Up

Get Started

API Reference

Previous

Next Up