Platform

Partially updates a task with the specified ID.

Platform (v1-2025-04-18)

The Platform API contains tenant level configuration and settings used throughout Rhythm. This includes Saved Queries, Custom Fields, and Forms.

Download OpenAPI description

platform-v1.json

platform-v1.yaml

Servers

Mock server

https://docs.api.rhythmsoftware.com/_mock/apis/platform/platform-v1/

https://platform.api.rhythmsoftware.com/

360 Screens

Operations

Custom Fields

Operations

Custom Objects

Operations

Custom Query Definitions

Operations

Custom Record Actions

Operations

Customization Config Settings

Operations

Directory Entry Comments

Operations

Email Activities

Operations

Email Integrations

Operations

File Uploads

Operations

Page Layouts

Operations

Query Delivery Schedules

Operations

Query User Profiles

Operations

Record Alert Rule Sets

Operations

Record Alerts

Operations

Saved Queries

Operations

Saved Reports

Operations

Saved Searches

Operations

Service Configurations

Operations

Service Metadata

Operations

Task Assignment Roles

Operations

Task Queues

Operations

Task Types

Operations

Tasks

Operations

Creates a new task record that does not already exist.

Request

This method will auto-generate an ID and create a new task. If an ID is specified for the task, an error will be thrown.

Path

tenantIdstringrequired

The id of the tenant being accessed.

Bodyapplication/jsonrequired

The task that you would like to be saved.

applicationstring(Application)

The application with which this task is affiliated

assignee_idstring(Assignee)

The user to whom this task is assigned

associated_contact_idstring(Associated Contact)

If the task is associated with a contact

associated_organization_idstring(Associated Organization)

If the task is associated with a contact

associated_recordsArray of objects

custom_field_valuesArray of objects(Custom Field Values)

descriptionstring(Description)

A description of this task

due_datestring(Due Date)required

The due date

idstring(ID)^[\w|-]+$required

The unique, string identifier of this task

namestring(Name)required

The name of the task

order_idstring(Order)

The order with which this task is associated

order_line_item_idstring(Order Line Item)

The order line item with which this task is associated

owner_idstring(Owner)required

The user that owns this task

prioritystring(Priority)

Enum"high""low""normal""urgent"

queue_idstring(Queue)

The queue to which this task is assigned

queue_prioritynumber(float)(Queue Priority)

The priority in the queue

remind_assigneeboolean(Remind Assignee)

If true, the assignee should be reminded of this task via email

reminder_datestring(date-time)(Reminder Date)required

The date to remind

statusstring(Status)required

Enum"completed""deferred""open""waiting for someone else"

sys_bulk_load_atstring(Sys Bulk Load At)

If this record was loaded via bulk, the timestamp when the record was processed

sys_bulk_load_idstring(Sys Bulk Load)

If this record was loaded via bulk, the ID of the bulk load process

sys_bulk_load_pkstring(Sys Bulk Load Pk)

If this record was loaded via bulk, the tenant and key of the bulk load process used as a partition key

sys_bulk_load_record_nonumber(float)(Sys Bulk Load Record No)

If this record was loaded via bulk, the record number in the source file

sys_bulk_load_source_filestring(Sys Bulk Load Source File)

If this record was loaded via bulk, the source file

sys_calculated_field_errorstring(Sys Calculated Field Error)

The error associated with the calculated field

sys_calculated_field_errorsArray of objects

sys_configuration_snapshot_idstring(Sys Configuration Snapshot)

If a snapshot was restored/applies to this record, the ID of the snapshot

sys_created_atstring(date-time)(Sys Created At)required

The date/time that this record was created, expressed in ISO-8601 date format

sys_created_by_idstring(Sys Created By)required

The ID of the user that created this record

sys_deleted_by_idstring(Sys Deleted By)

The ID of the user that deleted (or last tried to delete) this object

sys_directivestring(Sys Directive)

Means for passing directive information into an object processing logic

sys_external_idstring(Sys External)

The ID that a record has from an external system or data import

sys_has_files_in_s3boolean(Sys Has Files In S3)

If true, this record has files in S3. If false, it doesnt, so no need to hit S3 upon deletion

sys_last_bulk_data_operation_idstring(Sys Last Bulk Data Operation)

If this record was last touched by a bulk data operation, the ID of that operation

sys_last_bulk_data_operation_sys_versionstring(Sys Last Bulk Data Operation Sys Version)

If this record was last touched by a bulk data operation, the sys_version at the time of that operation

sys_last_modified_atstring(date-time)(Sys Last Modified At)required

The date/time that this record record was last modified, expressed in ISO-8601 date format

sys_last_modified_by_idstring(Sys Last Modified By)required

The ID of the user that last modified this record

sys_last_security_contextobject(Sys Last Security Context)

The security context of the last insert, modify, or delete performed on this item

sys_lockedboolean(Sys Locked)

If set, this record is locked and cannot be changed via the API

sys_snapshot_base_versionnumber(float)(Sys Snapshot Base Version)

The version to use as a base when creating a configuration snapshot; if not set, 1 is used. Helpful when creating a sandbox

sys_versionnumber(float)(Sys Version)

A number representing the version of this record in the database

task_group_idstring(Task Group)

When tasks are linked, this is the UUID of the grouping

type_idstring(Type)required

The type of task

curl -i -X POST \
  'https://docs.api.rhythmsoftware.com/_mock/apis/platform/platform-v1/tasks/{tenantId}' \
  -H 'Authorization: Bearer <YOUR_JWT_HERE>' \
  -H 'Content-Type: application/json' \
  -d '{
    "application": "string",
    "assignee_id": "string",
    "associated_contact_id": "string",
    "associated_organization_id": "string",
    "associated_records": [
      {
        "record_id": "string",
        "record_service": "string"
      }
    ],
    "custom_field_values": [
      {
        "boolean_value": true,
        "custom_field_id": "string",
        "file_url_value": "string",
        "list_value": [
          "string"
        ],
        "numeric_value": 0.1,
        "string_value": "string",
        "table_value": [
          {}
        ]
      }
    ],
    "description": "string",
    "due_date": "string",
    "id": "string",
    "name": "string",
    "order_id": "string",
    "order_line_item_id": "string",
    "owner_id": "string",
    "priority": "high",
    "queue_id": "string",
    "queue_priority": 0.1,
    "remind_assignee": true,
    "reminder_date": "2019-08-24T14:15:22Z",
    "status": "completed",
    "sys_bulk_load_at": "string",
    "sys_bulk_load_id": "string",
    "sys_bulk_load_pk": "string",
    "sys_bulk_load_record_no": 0.1,
    "sys_bulk_load_source_file": "string",
    "sys_calculated_field_error": "string",
    "sys_calculated_field_errors": [
      {
        "error": "string",
        "field": "string"
      }
    ],
    "sys_configuration_snapshot_id": "string",
    "sys_created_at": "2019-08-24T14:15:22Z",
    "sys_created_by_id": "string",
    "sys_deleted_by_id": "string",
    "sys_directive": "string",
    "sys_external_id": "string",
    "sys_has_files_in_s3": true,
    "sys_last_bulk_data_operation_id": "string",
    "sys_last_bulk_data_operation_sys_version": "string",
    "sys_last_modified_at": "2019-08-24T14:15:22Z",
    "sys_last_modified_by_id": "string",
    "sys_last_security_context": {},
    "sys_locked": true,
    "sys_snapshot_base_version": 0.1,
    "sys_version": 0.1,
    "task_group_id": "string",
    "type_id": "string"
  }'

Responses

The task was saved successfully.

Headers

Access-Control-Allow-Headersstring

Access-Control-Allow-Methodsstring

Access-Control-Allow-Originstring

Bodyapplication/json

applicationstring(Application)

The application with which this task is affiliated

assignee_idstring(Assignee)

The user to whom this task is assigned

associated_contact_idstring(Associated Contact)

If the task is associated with a contact

associated_organization_idstring(Associated Organization)

If the task is associated with a contact

associated_recordsArray of objects

custom_field_valuesArray of objects(Custom Field Values)

descriptionstring(Description)

A description of this task

due_datestring(Due Date)required

The due date

idstring(ID)^[\w|-]+$required

The unique, string identifier of this task

namestring(Name)required

The name of the task

order_idstring(Order)

The order with which this task is associated

order_line_item_idstring(Order Line Item)

The order line item with which this task is associated

owner_idstring(Owner)required

The user that owns this task

prioritystring(Priority)

Enum"high""low""normal""urgent"

queue_idstring(Queue)

The queue to which this task is assigned

queue_prioritynumber(float)(Queue Priority)

The priority in the queue

remind_assigneeboolean(Remind Assignee)

If true, the assignee should be reminded of this task via email

reminder_datestring(date-time)(Reminder Date)required

The date to remind

statusstring(Status)required

Enum"completed""deferred""open""waiting for someone else"

sys_bulk_load_atstring(Sys Bulk Load At)

If this record was loaded via bulk, the timestamp when the record was processed

sys_bulk_load_idstring(Sys Bulk Load)

If this record was loaded via bulk, the ID of the bulk load process

sys_bulk_load_pkstring(Sys Bulk Load Pk)

If this record was loaded via bulk, the tenant and key of the bulk load process used as a partition key

sys_bulk_load_record_nonumber(float)(Sys Bulk Load Record No)

If this record was loaded via bulk, the record number in the source file

sys_bulk_load_source_filestring(Sys Bulk Load Source File)

If this record was loaded via bulk, the source file

sys_calculated_field_errorstring(Sys Calculated Field Error)

The error associated with the calculated field

sys_calculated_field_errorsArray of objects

sys_configuration_snapshot_idstring(Sys Configuration Snapshot)

If a snapshot was restored/applies to this record, the ID of the snapshot

sys_created_atstring(date-time)(Sys Created At)required

The date/time that this record was created, expressed in ISO-8601 date format

sys_created_by_idstring(Sys Created By)required

The ID of the user that created this record

sys_deleted_by_idstring(Sys Deleted By)

The ID of the user that deleted (or last tried to delete) this object

sys_directivestring(Sys Directive)

Means for passing directive information into an object processing logic

sys_external_idstring(Sys External)

The ID that a record has from an external system or data import

sys_has_files_in_s3boolean(Sys Has Files In S3)

If true, this record has files in S3. If false, it doesnt, so no need to hit S3 upon deletion

sys_last_bulk_data_operation_idstring(Sys Last Bulk Data Operation)

If this record was last touched by a bulk data operation, the ID of that operation

sys_last_bulk_data_operation_sys_versionstring(Sys Last Bulk Data Operation Sys Version)

If this record was last touched by a bulk data operation, the sys_version at the time of that operation

sys_last_modified_atstring(date-time)(Sys Last Modified At)required

The date/time that this record record was last modified, expressed in ISO-8601 date format

sys_last_modified_by_idstring(Sys Last Modified By)required

The ID of the user that last modified this record

sys_last_security_contextobject(Sys Last Security Context)

The security context of the last insert, modify, or delete performed on this item

sys_lockedboolean(Sys Locked)

If set, this record is locked and cannot be changed via the API

sys_snapshot_base_versionnumber(float)(Sys Snapshot Base Version)

The version to use as a base when creating a configuration snapshot; if not set, 1 is used. Helpful when creating a sandbox

sys_versionnumber(float)(Sys Version)

A number representing the version of this record in the database

task_group_idstring(Task Group)

When tasks are linked, this is the UUID of the grouping

type_idstring(Type)required

The type of task

Response

application/json

{
  "application": "string",
  "assignee_id": "string",
  "associated_contact_id": "string",
  "associated_organization_id": "string",
  "associated_records": [
    { … }
  ],
  "custom_field_values": [
    { … }
  ],
  "description": "string",
  "due_date": "string",
  "id": "string",
  "name": "string",
  "order_id": "string",
  "order_line_item_id": "string",
  "owner_id": "string",
  "priority": "high",
  "queue_id": "string",
  "queue_priority": 0.1,
  "remind_assignee": true,
  "reminder_date": "2019-08-24T14:15:22Z",
  "status": "completed",
  "sys_bulk_load_at": "string",
  "sys_bulk_load_id": "string",
  "sys_bulk_load_pk": "string",
  "sys_bulk_load_record_no": 0.1,
  "sys_bulk_load_source_file": "string",
  "sys_calculated_field_error": "string",
  "sys_calculated_field_errors": [
    { … }
  ],
  "sys_configuration_snapshot_id": "string",
  "sys_created_at": "2019-08-24T14:15:22Z",
  "sys_created_by_id": "string",
  "sys_deleted_by_id": "string",
  "sys_directive": "string",
  "sys_external_id": "string",
  "sys_has_files_in_s3": true,
  "sys_last_bulk_data_operation_id": "string",
  "sys_last_bulk_data_operation_sys_version": "string",
  "sys_last_modified_at": "2019-08-24T14:15:22Z",
  "sys_last_modified_by_id": "string",
  "sys_last_security_context": {},
  "sys_locked": true,
  "sys_snapshot_base_version": 0.1,
  "sys_version": 0.1,
  "task_group_id": "string",
  "type_id": "string"
}

Returns a list of records with the specified assignee_id

Request

Returns a list of records with the specified assignee_id

Path

tenantIdstringrequired

The tenant

assignee_idstringrequired

The assignee_id to use to for record lookup

Query

fieldsstring

The fields that you want to retrieve; if omitted, the entire object is returned

exclusiveStartKeystring

If paging, this allows you to return the next set of results

curl -i -X GET \
  'https://docs.api.rhythmsoftware.com/_mock/apis/platform/platform-v1/tasks/{tenantId}/assignee/{assignee_id}?exclusiveStartKey=string&fields=string' \
  -H 'Authorization: Bearer <YOUR_JWT_HERE>'

Responses

The records were retrieved successfully

Headers

Access-Control-Allow-Headersstring

Access-Control-Allow-Methodsstring

Access-Control-Allow-Originstring

Bodyapplication/json

Countinteger

ItemsArray of objects(Task)

LastEvaluatedKeystring

Response

application/json

{
  "Count": 0,
  "Items": [
    { … }
  ],
  "LastEvaluatedKey": "string"
}

Returns a list of records with the specified associated_contact_id

Request

Returns a list of records with the specified associated_contact_id

Path

tenantIdstringrequired

The tenant

associated_contact_idstringrequired

The associated_contact_id to use to for record lookup

Query

fieldsstring

The fields that you want to retrieve; if omitted, the entire object is returned

exclusiveStartKeystring

If paging, this allows you to return the next set of results

curl -i -X GET \
  'https://docs.api.rhythmsoftware.com/_mock/apis/platform/platform-v1/tasks/{tenantId}/associatedContact/{associated_contact_id}?exclusiveStartKey=string&fields=string' \
  -H 'Authorization: Bearer <YOUR_JWT_HERE>'

Responses

The records were retrieved successfully

Headers

Access-Control-Allow-Headersstring

Access-Control-Allow-Methodsstring

Access-Control-Allow-Originstring

Bodyapplication/json

Countinteger

ItemsArray of objects(Task)

LastEvaluatedKeystring

Response

application/json

{
  "Count": 0,
  "Items": [
    { … }
  ],
  "LastEvaluatedKey": "string"
}

Returns a list of records with the specified associated_organization_id

Request

Returns a list of records with the specified associated_organization_id

Path

tenantIdstringrequired

The tenant

associated_organization_idstringrequired

The associated_organization_id to use to for record lookup

Query

fieldsstring

The fields that you want to retrieve; if omitted, the entire object is returned

exclusiveStartKeystring

If paging, this allows you to return the next set of results

curl -i -X GET \
  'https://docs.api.rhythmsoftware.com/_mock/apis/platform/platform-v1/tasks/{tenantId}/associatedOrganization/{associated_organization_id}?exclusiveStartKey=string&fields=string' \
  -H 'Authorization: Bearer <YOUR_JWT_HERE>'

Responses

The records were retrieved successfully

Headers

Access-Control-Allow-Headersstring

Access-Control-Allow-Methodsstring

Access-Control-Allow-Originstring

Bodyapplication/json

Countinteger

ItemsArray of objects(Task)

LastEvaluatedKeystring

Response

application/json

{
  "Count": 0,
  "Items": [
    { … }
  ],
  "LastEvaluatedKey": "string"
}

Returns a list of records with the specified sys_search_associated_record_id

Request

Returns a list of records with the specified sys_search_associated_record_id

Path

tenantIdstringrequired

The tenant

servicestringrequired

The service

record_idstringrequired

The record id

Query

fieldsstring

The fields that you want to retrieve; if omitted, the entire object is returned

exclusiveStartKeystring

If paging, this allows you to return the next set of results

curl -i -X GET \
  'https://docs.api.rhythmsoftware.com/_mock/apis/platform/platform-v1/tasks/{tenantId}/associatedRecord/{service}/{record_id}?exclusiveStartKey=string&fields=string' \
  -H 'Authorization: Bearer <YOUR_JWT_HERE>'

Responses

The records were retrieved successfully

Headers

Access-Control-Allow-Headersstring

Access-Control-Allow-Methodsstring

Access-Control-Allow-Originstring

Bodyapplication/json

Countinteger

ItemsArray of objects(Task)

LastEvaluatedKeystring

Response

application/json

{
  "Count": 0,
  "Items": [
    { … }
  ],
  "LastEvaluatedKey": "string"
}

Returns a list of records with the specified owner_id

Request

Returns a list of records with the specified owner_id

Path

tenantIdstringrequired

The tenant

owner_idstringrequired

The owner_id to use to for record lookup

Query

fieldsstring

The fields that you want to retrieve; if omitted, the entire object is returned

exclusiveStartKeystring

If paging, this allows you to return the next set of results

curl -i -X GET \
  'https://docs.api.rhythmsoftware.com/_mock/apis/platform/platform-v1/tasks/{tenantId}/owner/{owner_id}?exclusiveStartKey=string&fields=string' \
  -H 'Authorization: Bearer <YOUR_JWT_HERE>'

Responses

The records were retrieved successfully

Headers

Access-Control-Allow-Headersstring

Access-Control-Allow-Methodsstring

Access-Control-Allow-Originstring

Bodyapplication/json

Countinteger

ItemsArray of objects(Task)

LastEvaluatedKeystring

Response

application/json

{
  "Count": 0,
  "Items": [
    { … }
  ],
  "LastEvaluatedKey": "string"
}

Returns a list of records with the specified queue_id

Request

Returns a list of records with the specified queue_id

Path

tenantIdstringrequired

The tenant

queue_idstringrequired

The queue_id to use to for record lookup

Query

fieldsstring

The fields that you want to retrieve; if omitted, the entire object is returned

exclusiveStartKeystring

If paging, this allows you to return the next set of results

curl -i -X GET \
  'https://docs.api.rhythmsoftware.com/_mock/apis/platform/platform-v1/tasks/{tenantId}/queue/{queue_id}?exclusiveStartKey=string&fields=string' \
  -H 'Authorization: Bearer <YOUR_JWT_HERE>'

Responses

The records were retrieved successfully

Headers

Access-Control-Allow-Headersstring

Access-Control-Allow-Methodsstring

Access-Control-Allow-Originstring

Bodyapplication/json

Countinteger

ItemsArray of objects(Task)

LastEvaluatedKeystring

Response

application/json

{
  "Count": 0,
  "Items": [
    { … }
  ],
  "LastEvaluatedKey": "string"
}

Searches for tasks using predefined parameters

Request

Searches for tasks using predefined parameters

Path

tenantIdstringrequired

The id of the tenant being accessed.

Query

exclusiveStartKeystring

The start key for the search, for paging support

fieldsToReturnstring

The fields that you want to retrieve; if omitted, the entire object is returned

Bodyapplication/jsonrequired

The task that you would like to be saved.

nameArray of strings(Name)

priorityArray of strings(Priority)

type_idArray of strings(Type)

curl -i -X POST \
  'https://docs.api.rhythmsoftware.com/_mock/apis/platform/platform-v1/tasks/{tenantId}/search?exclusiveStartKey=string&fieldsToReturn=string' \
  -H 'Authorization: Bearer <YOUR_JWT_HERE>' \
  -H 'Content-Type: application/json' \
  -d '{
    "name": [
      "string"
    ],
    "priority": [
      "string"
    ],
    "type_id": [
      "string"
    ]
  }'

Responses

The task search was saved successfully.

Headers

Access-Control-Allow-Headersstring

Access-Control-Allow-Methodsstring

Access-Control-Allow-Originstring

Bodyapplication/json

ItemsArray of objects(TaskSearchResults)

LastEvaluatedKeystring

Response

application/json

{
  "Items": [
    { … }
  ],
  "LastEvaluatedKey": "string"
}

Returns a list of records with the specified task_group_id

Request

Returns a list of records with the specified task_group_id

Path

tenantIdstringrequired

The tenant

task_group_idstringrequired

The task_group_id to use to for record lookup

Query

fieldsstring

The fields that you want to retrieve; if omitted, the entire object is returned

exclusiveStartKeystring

If paging, this allows you to return the next set of results

curl -i -X GET \
  'https://docs.api.rhythmsoftware.com/_mock/apis/platform/platform-v1/tasks/{tenantId}/taskGroup/{task_group_id}?exclusiveStartKey=string&fields=string' \
  -H 'Authorization: Bearer <YOUR_JWT_HERE>'

Responses

The records were retrieved successfully

Headers

Access-Control-Allow-Headersstring

Access-Control-Allow-Methodsstring

Access-Control-Allow-Originstring

Bodyapplication/json

Countinteger

ItemsArray of objects(Task)

LastEvaluatedKeystring

Response

application/json

{
  "Count": 0,
  "Items": [
    { … }
  ],
  "LastEvaluatedKey": "string"
}

Returns a task from the system by its ID.

Request

This method will delete a task with the specified ID.

Path

tenantIdstringrequired

The id of the tenant being accessed.

idstringrequired

The ID of the task to delete.

curl -i -X DELETE \
  'https://docs.api.rhythmsoftware.com/_mock/apis/platform/platform-v1/tasks/{tenantId}/{id}' \
  -H 'Authorization: Bearer <YOUR_JWT_HERE>'

Responses

The task was deleted successfully.

Headers

Access-Control-Allow-Headersstring

Access-Control-Allow-Methodsstring

Access-Control-Allow-Originstring

Bodyapplication/json

string

Response

application/json

"string"

Returns a task from the system by its ID.

Request

This method will look up a task by the specified ID and return it back.

Path

tenantIdstringrequired

The id of the tenant being accessed.

idstringrequired

The ID of the task to return.

Query

fieldsstring

The fields that you want to retrieve; if omitted, the entire object is returned.

consistentReadstring

Indicates the API should force a consistent read on the data source.

curl -i -X GET \
  'https://docs.api.rhythmsoftware.com/_mock/apis/platform/platform-v1/tasks/{tenantId}/{id}?consistentRead=string&fields=string' \
  -H 'Authorization: Bearer <YOUR_JWT_HERE>'

Responses

The task was retrieved successfully.

Headers

Access-Control-Allow-Headersstring

Access-Control-Allow-Methodsstring

Access-Control-Allow-Originstring

Bodyapplication/json

applicationstring(Application)

The application with which this task is affiliated

assignee_idstring(Assignee)

The user to whom this task is assigned

associated_contact_idstring(Associated Contact)

If the task is associated with a contact

associated_organization_idstring(Associated Organization)

If the task is associated with a contact

associated_recordsArray of objects

custom_field_valuesArray of objects(Custom Field Values)

descriptionstring(Description)

A description of this task

due_datestring(Due Date)required

The due date

idstring(ID)^[\w|-]+$required

The unique, string identifier of this task

namestring(Name)required

The name of the task

order_idstring(Order)

The order with which this task is associated

order_line_item_idstring(Order Line Item)

The order line item with which this task is associated

owner_idstring(Owner)required

The user that owns this task

prioritystring(Priority)

Enum"high""low""normal""urgent"

queue_idstring(Queue)

The queue to which this task is assigned

queue_prioritynumber(float)(Queue Priority)

The priority in the queue

remind_assigneeboolean(Remind Assignee)

If true, the assignee should be reminded of this task via email

reminder_datestring(date-time)(Reminder Date)required

The date to remind

statusstring(Status)required

Enum"completed""deferred""open""waiting for someone else"

sys_bulk_load_atstring(Sys Bulk Load At)

If this record was loaded via bulk, the timestamp when the record was processed

sys_bulk_load_idstring(Sys Bulk Load)

If this record was loaded via bulk, the ID of the bulk load process

sys_bulk_load_pkstring(Sys Bulk Load Pk)

If this record was loaded via bulk, the tenant and key of the bulk load process used as a partition key

sys_bulk_load_record_nonumber(float)(Sys Bulk Load Record No)

If this record was loaded via bulk, the record number in the source file

sys_bulk_load_source_filestring(Sys Bulk Load Source File)

If this record was loaded via bulk, the source file

sys_calculated_field_errorstring(Sys Calculated Field Error)

The error associated with the calculated field

sys_calculated_field_errorsArray of objects

sys_configuration_snapshot_idstring(Sys Configuration Snapshot)

If a snapshot was restored/applies to this record, the ID of the snapshot

sys_created_atstring(date-time)(Sys Created At)required

The date/time that this record was created, expressed in ISO-8601 date format

sys_created_by_idstring(Sys Created By)required

The ID of the user that created this record

sys_deleted_by_idstring(Sys Deleted By)

The ID of the user that deleted (or last tried to delete) this object

sys_directivestring(Sys Directive)

Means for passing directive information into an object processing logic

sys_external_idstring(Sys External)

The ID that a record has from an external system or data import

sys_has_files_in_s3boolean(Sys Has Files In S3)

If true, this record has files in S3. If false, it doesnt, so no need to hit S3 upon deletion

sys_last_bulk_data_operation_idstring(Sys Last Bulk Data Operation)

If this record was last touched by a bulk data operation, the ID of that operation

sys_last_bulk_data_operation_sys_versionstring(Sys Last Bulk Data Operation Sys Version)

If this record was last touched by a bulk data operation, the sys_version at the time of that operation

sys_last_modified_atstring(date-time)(Sys Last Modified At)required

The date/time that this record record was last modified, expressed in ISO-8601 date format

sys_last_modified_by_idstring(Sys Last Modified By)required

The ID of the user that last modified this record

sys_last_security_contextobject(Sys Last Security Context)

The security context of the last insert, modify, or delete performed on this item

sys_lockedboolean(Sys Locked)

If set, this record is locked and cannot be changed via the API

sys_snapshot_base_versionnumber(float)(Sys Snapshot Base Version)

The version to use as a base when creating a configuration snapshot; if not set, 1 is used. Helpful when creating a sandbox

sys_versionnumber(float)(Sys Version)

A number representing the version of this record in the database

task_group_idstring(Task Group)

When tasks are linked, this is the UUID of the grouping

type_idstring(Type)required

The type of task

Response

application/json

{
  "application": "string",
  "assignee_id": "string",
  "associated_contact_id": "string",
  "associated_organization_id": "string",
  "associated_records": [
    { … }
  ],
  "custom_field_values": [
    { … }
  ],
  "description": "string",
  "due_date": "string",
  "id": "string",
  "name": "string",
  "order_id": "string",
  "order_line_item_id": "string",
  "owner_id": "string",
  "priority": "high",
  "queue_id": "string",
  "queue_priority": 0.1,
  "remind_assignee": true,
  "reminder_date": "2019-08-24T14:15:22Z",
  "status": "completed",
  "sys_bulk_load_at": "string",
  "sys_bulk_load_id": "string",
  "sys_bulk_load_pk": "string",
  "sys_bulk_load_record_no": 0.1,
  "sys_bulk_load_source_file": "string",
  "sys_calculated_field_error": "string",
  "sys_calculated_field_errors": [
    { … }
  ],
  "sys_configuration_snapshot_id": "string",
  "sys_created_at": "2019-08-24T14:15:22Z",
  "sys_created_by_id": "string",
  "sys_deleted_by_id": "string",
  "sys_directive": "string",
  "sys_external_id": "string",
  "sys_has_files_in_s3": true,
  "sys_last_bulk_data_operation_id": "string",
  "sys_last_bulk_data_operation_sys_version": "string",
  "sys_last_modified_at": "2019-08-24T14:15:22Z",
  "sys_last_modified_by_id": "string",
  "sys_last_security_context": {},
  "sys_locked": true,
  "sys_snapshot_base_version": 0.1,
  "sys_version": 0.1,
  "task_group_id": "string",
  "type_id": "string"
}

Partially updates a task with the specified ID.

Request

This method will patch an existing task with the specified ID, using the HTTP PATCH specification.

Path

tenantIdstringrequired

The id of the tenant being accessed.

idstringrequired

The ID of the task to patch.

Bodyapplication/jsonrequired

The patch directives conforming to RFC 6902.

Array [

opstring(Op)required

The operation

Enum"add""copy""move""remove""replace""test"

pathstring(Path)required

The JSON path

valuestring(Value)

The updated value

]

curl -i -X PATCH \
  'https://docs.api.rhythmsoftware.com/_mock/apis/platform/platform-v1/tasks/{tenantId}/{id}' \
  -H 'Authorization: Bearer <YOUR_JWT_HERE>' \
  -H 'Content-Type: application/json' \
  -d '[
    {
      "op": "add",
      "path": "string",
      "value": "string"
    }
  ]'

Responses

The task was patched successfully.

Headers

Access-Control-Allow-Headersstring

Access-Control-Allow-Methodsstring

Access-Control-Allow-Originstring

Bodyapplication/json

applicationstring(Application)

The application with which this task is affiliated

assignee_idstring(Assignee)

The user to whom this task is assigned

associated_contact_idstring(Associated Contact)

If the task is associated with a contact

associated_organization_idstring(Associated Organization)

If the task is associated with a contact

associated_recordsArray of objects

custom_field_valuesArray of objects(Custom Field Values)

descriptionstring(Description)

A description of this task

due_datestring(Due Date)required

The due date

idstring(ID)^[\w|-]+$required

The unique, string identifier of this task

namestring(Name)required

The name of the task

order_idstring(Order)

The order with which this task is associated

order_line_item_idstring(Order Line Item)

The order line item with which this task is associated

owner_idstring(Owner)required

The user that owns this task

prioritystring(Priority)

Enum"high""low""normal""urgent"

queue_idstring(Queue)

The queue to which this task is assigned

queue_prioritynumber(float)(Queue Priority)

The priority in the queue

remind_assigneeboolean(Remind Assignee)

If true, the assignee should be reminded of this task via email

reminder_datestring(date-time)(Reminder Date)required

The date to remind

statusstring(Status)required

Enum"completed""deferred""open""waiting for someone else"

sys_bulk_load_atstring(Sys Bulk Load At)

If this record was loaded via bulk, the timestamp when the record was processed

sys_bulk_load_idstring(Sys Bulk Load)

If this record was loaded via bulk, the ID of the bulk load process

sys_bulk_load_pkstring(Sys Bulk Load Pk)

If this record was loaded via bulk, the tenant and key of the bulk load process used as a partition key

sys_bulk_load_record_nonumber(float)(Sys Bulk Load Record No)

If this record was loaded via bulk, the record number in the source file

sys_bulk_load_source_filestring(Sys Bulk Load Source File)

If this record was loaded via bulk, the source file

sys_calculated_field_errorstring(Sys Calculated Field Error)

The error associated with the calculated field

sys_calculated_field_errorsArray of objects

sys_configuration_snapshot_idstring(Sys Configuration Snapshot)

If a snapshot was restored/applies to this record, the ID of the snapshot

sys_created_atstring(date-time)(Sys Created At)required

The date/time that this record was created, expressed in ISO-8601 date format

sys_created_by_idstring(Sys Created By)required

The ID of the user that created this record

sys_deleted_by_idstring(Sys Deleted By)

The ID of the user that deleted (or last tried to delete) this object

sys_directivestring(Sys Directive)

Means for passing directive information into an object processing logic

sys_external_idstring(Sys External)

The ID that a record has from an external system or data import

sys_has_files_in_s3boolean(Sys Has Files In S3)

If true, this record has files in S3. If false, it doesnt, so no need to hit S3 upon deletion

sys_last_bulk_data_operation_idstring(Sys Last Bulk Data Operation)

If this record was last touched by a bulk data operation, the ID of that operation

sys_last_bulk_data_operation_sys_versionstring(Sys Last Bulk Data Operation Sys Version)

If this record was last touched by a bulk data operation, the sys_version at the time of that operation

sys_last_modified_atstring(date-time)(Sys Last Modified At)required

The date/time that this record record was last modified, expressed in ISO-8601 date format

sys_last_modified_by_idstring(Sys Last Modified By)required

The ID of the user that last modified this record

sys_last_security_contextobject(Sys Last Security Context)

The security context of the last insert, modify, or delete performed on this item

sys_lockedboolean(Sys Locked)

If set, this record is locked and cannot be changed via the API

sys_snapshot_base_versionnumber(float)(Sys Snapshot Base Version)

The version to use as a base when creating a configuration snapshot; if not set, 1 is used. Helpful when creating a sandbox

sys_versionnumber(float)(Sys Version)

A number representing the version of this record in the database

task_group_idstring(Task Group)

When tasks are linked, this is the UUID of the grouping

type_idstring(Type)required

The type of task

Response

application/json

{
  "application": "string",
  "assignee_id": "string",
  "associated_contact_id": "string",
  "associated_organization_id": "string",
  "associated_records": [
    { … }
  ],
  "custom_field_values": [
    { … }
  ],
  "description": "string",
  "due_date": "string",
  "id": "string",
  "name": "string",
  "order_id": "string",
  "order_line_item_id": "string",
  "owner_id": "string",
  "priority": "high",
  "queue_id": "string",
  "queue_priority": 0.1,
  "remind_assignee": true,
  "reminder_date": "2019-08-24T14:15:22Z",
  "status": "completed",
  "sys_bulk_load_at": "string",
  "sys_bulk_load_id": "string",
  "sys_bulk_load_pk": "string",
  "sys_bulk_load_record_no": 0.1,
  "sys_bulk_load_source_file": "string",
  "sys_calculated_field_error": "string",
  "sys_calculated_field_errors": [
    { … }
  ],
  "sys_configuration_snapshot_id": "string",
  "sys_created_at": "2019-08-24T14:15:22Z",
  "sys_created_by_id": "string",
  "sys_deleted_by_id": "string",
  "sys_directive": "string",
  "sys_external_id": "string",
  "sys_has_files_in_s3": true,
  "sys_last_bulk_data_operation_id": "string",
  "sys_last_bulk_data_operation_sys_version": "string",
  "sys_last_modified_at": "2019-08-24T14:15:22Z",
  "sys_last_modified_by_id": "string",
  "sys_last_security_context": {},
  "sys_locked": true,
  "sys_snapshot_base_version": 0.1,
  "sys_version": 0.1,
  "task_group_id": "string",
  "type_id": "string"
}

Updates a task with the specified ID.

Request

This method will update an existing task with the specified ID.

Path

tenantIdstringrequired

The id of the tenant being accessed.

idstringrequired

The ID of the task to update.

Bodyapplication/jsonrequired

The updated task that will be saved.

applicationstring(Application)

The application with which this task is affiliated

assignee_idstring(Assignee)

The user to whom this task is assigned

associated_contact_idstring(Associated Contact)

If the task is associated with a contact

associated_organization_idstring(Associated Organization)

If the task is associated with a contact

associated_recordsArray of objects

custom_field_valuesArray of objects(Custom Field Values)

descriptionstring(Description)

A description of this task

due_datestring(Due Date)required

The due date

idstring(ID)^[\w|-]+$required

The unique, string identifier of this task

namestring(Name)required

The name of the task

order_idstring(Order)

The order with which this task is associated

order_line_item_idstring(Order Line Item)

The order line item with which this task is associated

owner_idstring(Owner)required

The user that owns this task

prioritystring(Priority)

Enum"high""low""normal""urgent"

queue_idstring(Queue)

The queue to which this task is assigned

queue_prioritynumber(float)(Queue Priority)

The priority in the queue

remind_assigneeboolean(Remind Assignee)

If true, the assignee should be reminded of this task via email

reminder_datestring(date-time)(Reminder Date)required

The date to remind

statusstring(Status)required

Enum"completed""deferred""open""waiting for someone else"

sys_bulk_load_atstring(Sys Bulk Load At)

If this record was loaded via bulk, the timestamp when the record was processed

sys_bulk_load_idstring(Sys Bulk Load)

If this record was loaded via bulk, the ID of the bulk load process

sys_bulk_load_pkstring(Sys Bulk Load Pk)

If this record was loaded via bulk, the tenant and key of the bulk load process used as a partition key

sys_bulk_load_record_nonumber(float)(Sys Bulk Load Record No)

If this record was loaded via bulk, the record number in the source file

sys_bulk_load_source_filestring(Sys Bulk Load Source File)

If this record was loaded via bulk, the source file

sys_calculated_field_errorstring(Sys Calculated Field Error)

The error associated with the calculated field

sys_calculated_field_errorsArray of objects

sys_configuration_snapshot_idstring(Sys Configuration Snapshot)

If a snapshot was restored/applies to this record, the ID of the snapshot

sys_created_atstring(date-time)(Sys Created At)required

The date/time that this record was created, expressed in ISO-8601 date format

sys_created_by_idstring(Sys Created By)required

The ID of the user that created this record

sys_deleted_by_idstring(Sys Deleted By)

The ID of the user that deleted (or last tried to delete) this object

sys_directivestring(Sys Directive)

Means for passing directive information into an object processing logic

sys_external_idstring(Sys External)

The ID that a record has from an external system or data import

sys_has_files_in_s3boolean(Sys Has Files In S3)

If true, this record has files in S3. If false, it doesnt, so no need to hit S3 upon deletion

sys_last_bulk_data_operation_idstring(Sys Last Bulk Data Operation)

If this record was last touched by a bulk data operation, the ID of that operation

sys_last_bulk_data_operation_sys_versionstring(Sys Last Bulk Data Operation Sys Version)

If this record was last touched by a bulk data operation, the sys_version at the time of that operation

sys_last_modified_atstring(date-time)(Sys Last Modified At)required

The date/time that this record record was last modified, expressed in ISO-8601 date format

sys_last_modified_by_idstring(Sys Last Modified By)required

The ID of the user that last modified this record

sys_last_security_contextobject(Sys Last Security Context)

The security context of the last insert, modify, or delete performed on this item

sys_lockedboolean(Sys Locked)

If set, this record is locked and cannot be changed via the API

sys_snapshot_base_versionnumber(float)(Sys Snapshot Base Version)

The version to use as a base when creating a configuration snapshot; if not set, 1 is used. Helpful when creating a sandbox

sys_versionnumber(float)(Sys Version)

A number representing the version of this record in the database

task_group_idstring(Task Group)

When tasks are linked, this is the UUID of the grouping

type_idstring(Type)required

The type of task

curl -i -X PUT \
  'https://docs.api.rhythmsoftware.com/_mock/apis/platform/platform-v1/tasks/{tenantId}/{id}' \
  -H 'Authorization: Bearer <YOUR_JWT_HERE>' \
  -H 'Content-Type: application/json' \
  -d '{
    "application": "string",
    "assignee_id": "string",
    "associated_contact_id": "string",
    "associated_organization_id": "string",
    "associated_records": [
      {
        "record_id": "string",
        "record_service": "string"
      }
    ],
    "custom_field_values": [
      {
        "boolean_value": true,
        "custom_field_id": "string",
        "file_url_value": "string",
        "list_value": [
          "string"
        ],
        "numeric_value": 0.1,
        "string_value": "string",
        "table_value": [
          {}
        ]
      }
    ],
    "description": "string",
    "due_date": "string",
    "id": "string",
    "name": "string",
    "order_id": "string",
    "order_line_item_id": "string",
    "owner_id": "string",
    "priority": "high",
    "queue_id": "string",
    "queue_priority": 0.1,
    "remind_assignee": true,
    "reminder_date": "2019-08-24T14:15:22Z",
    "status": "completed",
    "sys_bulk_load_at": "string",
    "sys_bulk_load_id": "string",
    "sys_bulk_load_pk": "string",
    "sys_bulk_load_record_no": 0.1,
    "sys_bulk_load_source_file": "string",
    "sys_calculated_field_error": "string",
    "sys_calculated_field_errors": [
      {
        "error": "string",
        "field": "string"
      }
    ],
    "sys_configuration_snapshot_id": "string",
    "sys_created_at": "2019-08-24T14:15:22Z",
    "sys_created_by_id": "string",
    "sys_deleted_by_id": "string",
    "sys_directive": "string",
    "sys_external_id": "string",
    "sys_has_files_in_s3": true,
    "sys_last_bulk_data_operation_id": "string",
    "sys_last_bulk_data_operation_sys_version": "string",
    "sys_last_modified_at": "2019-08-24T14:15:22Z",
    "sys_last_modified_by_id": "string",
    "sys_last_security_context": {},
    "sys_locked": true,
    "sys_snapshot_base_version": 0.1,
    "sys_version": 0.1,
    "task_group_id": "string",
    "type_id": "string"
  }'

Responses

The task was updated successfully.

Headers

Access-Control-Allow-Headersstring

Access-Control-Allow-Methodsstring

Access-Control-Allow-Originstring

Bodyapplication/json

applicationstring(Application)

The application with which this task is affiliated

assignee_idstring(Assignee)

The user to whom this task is assigned

associated_contact_idstring(Associated Contact)

If the task is associated with a contact

associated_organization_idstring(Associated Organization)

If the task is associated with a contact

associated_recordsArray of objects

custom_field_valuesArray of objects(Custom Field Values)

descriptionstring(Description)

A description of this task

due_datestring(Due Date)required

The due date

idstring(ID)^[\w|-]+$required

The unique, string identifier of this task

namestring(Name)required

The name of the task

order_idstring(Order)

The order with which this task is associated

order_line_item_idstring(Order Line Item)

The order line item with which this task is associated

owner_idstring(Owner)required

The user that owns this task

prioritystring(Priority)

Enum"high""low""normal""urgent"

queue_idstring(Queue)

The queue to which this task is assigned

queue_prioritynumber(float)(Queue Priority)

The priority in the queue

remind_assigneeboolean(Remind Assignee)

If true, the assignee should be reminded of this task via email

reminder_datestring(date-time)(Reminder Date)required

The date to remind

statusstring(Status)required

Enum"completed""deferred""open""waiting for someone else"

sys_bulk_load_atstring(Sys Bulk Load At)

If this record was loaded via bulk, the timestamp when the record was processed

sys_bulk_load_idstring(Sys Bulk Load)

If this record was loaded via bulk, the ID of the bulk load process

sys_bulk_load_pkstring(Sys Bulk Load Pk)

If this record was loaded via bulk, the tenant and key of the bulk load process used as a partition key

sys_bulk_load_record_nonumber(float)(Sys Bulk Load Record No)

If this record was loaded via bulk, the record number in the source file

sys_bulk_load_source_filestring(Sys Bulk Load Source File)

If this record was loaded via bulk, the source file

sys_calculated_field_errorstring(Sys Calculated Field Error)

The error associated with the calculated field

sys_calculated_field_errorsArray of objects

sys_configuration_snapshot_idstring(Sys Configuration Snapshot)

If a snapshot was restored/applies to this record, the ID of the snapshot

sys_created_atstring(date-time)(Sys Created At)required

The date/time that this record was created, expressed in ISO-8601 date format

sys_created_by_idstring(Sys Created By)required

The ID of the user that created this record

sys_deleted_by_idstring(Sys Deleted By)

The ID of the user that deleted (or last tried to delete) this object

sys_directivestring(Sys Directive)

Means for passing directive information into an object processing logic

sys_external_idstring(Sys External)

The ID that a record has from an external system or data import

sys_has_files_in_s3boolean(Sys Has Files In S3)

If true, this record has files in S3. If false, it doesnt, so no need to hit S3 upon deletion

sys_last_bulk_data_operation_idstring(Sys Last Bulk Data Operation)

If this record was last touched by a bulk data operation, the ID of that operation

sys_last_bulk_data_operation_sys_versionstring(Sys Last Bulk Data Operation Sys Version)

If this record was last touched by a bulk data operation, the sys_version at the time of that operation

sys_last_modified_atstring(date-time)(Sys Last Modified At)required

The date/time that this record record was last modified, expressed in ISO-8601 date format

sys_last_modified_by_idstring(Sys Last Modified By)required

The ID of the user that last modified this record

sys_last_security_contextobject(Sys Last Security Context)

The security context of the last insert, modify, or delete performed on this item

sys_lockedboolean(Sys Locked)

If set, this record is locked and cannot be changed via the API

sys_snapshot_base_versionnumber(float)(Sys Snapshot Base Version)

The version to use as a base when creating a configuration snapshot; if not set, 1 is used. Helpful when creating a sandbox

sys_versionnumber(float)(Sys Version)

A number representing the version of this record in the database

task_group_idstring(Task Group)

When tasks are linked, this is the UUID of the grouping

type_idstring(Type)required

The type of task

Response

application/json

{
  "application": "string",
  "assignee_id": "string",
  "associated_contact_id": "string",
  "associated_organization_id": "string",
  "associated_records": [
    { … }
  ],
  "custom_field_values": [
    { … }
  ],
  "description": "string",
  "due_date": "string",
  "id": "string",
  "name": "string",
  "order_id": "string",
  "order_line_item_id": "string",
  "owner_id": "string",
  "priority": "high",
  "queue_id": "string",
  "queue_priority": 0.1,
  "remind_assignee": true,
  "reminder_date": "2019-08-24T14:15:22Z",
  "status": "completed",
  "sys_bulk_load_at": "string",
  "sys_bulk_load_id": "string",
  "sys_bulk_load_pk": "string",
  "sys_bulk_load_record_no": 0.1,
  "sys_bulk_load_source_file": "string",
  "sys_calculated_field_error": "string",
  "sys_calculated_field_errors": [
    { … }
  ],
  "sys_configuration_snapshot_id": "string",
  "sys_created_at": "2019-08-24T14:15:22Z",
  "sys_created_by_id": "string",
  "sys_deleted_by_id": "string",
  "sys_directive": "string",
  "sys_external_id": "string",
  "sys_has_files_in_s3": true,
  "sys_last_bulk_data_operation_id": "string",
  "sys_last_bulk_data_operation_sys_version": "string",
  "sys_last_modified_at": "2019-08-24T14:15:22Z",
  "sys_last_modified_by_id": "string",
  "sys_last_security_context": {},
  "sys_locked": true,
  "sys_snapshot_base_version": 0.1,
  "sys_version": 0.1,
  "task_group_id": "string",
  "type_id": "string"
}

Web Form Drafts

Operations

Web Forms

Operations

Workflows

Operations

Platform (v1-2025-04-18)

360 Screens

Custom Fields

Custom Objects

Custom Query Definitions

Custom Record Actions

Customization Config Settings

Directory Entry Comments

Email Activities

Email Integrations

File Uploads

Page Layouts

Query Delivery Schedules

Query User Profiles

Record Alert Rule Sets

Record Alerts

Saved Queries

Saved Reports

Saved Searches

Service Configurations

Service Metadata

Task Assignment Roles

Task Queues

Task Types

Tasks

Creates a new task record that does not already exist.

RequestExpand all

Responses

Was this helpful?

Returns a list of records with the specified assignee_id

Request

Responses

Was this helpful?

Returns a list of records with the specified associated_contact_id

Request

Responses

Was this helpful?

Returns a list of records with the specified associated_organization_id

Request

Responses

Was this helpful?

Returns a list of records with the specified sys_search_associated_record_id

Request

Responses

Was this helpful?

Returns a list of records with the specified owner_id

Request

Responses

Was this helpful?

Returns a list of records with the specified queue_id

Request

Responses

Was this helpful?

Searches for tasks using predefined parameters

Request

Responses

Was this helpful?

Returns a list of records with the specified task_group_id

Request

Responses

Was this helpful?

Returns a task from the system by its ID.

Request

Responses

Was this helpful?

Returns a task from the system by its ID.

Request

Responses

Was this helpful?

Partially updates a task with the specified ID.

Request

Responses

Was this helpful?

Updates a task with the specified ID.

RequestExpand all

Responses

Was this helpful?

Web Form Drafts

Web Forms

Workflows

Request

Request