Tasks

Tasks Documentation

Task [LIST]

Request

Endpoint

GET /api/v2/tasks
Content-Type: application/vnd.api+json

Body

Parameters

Sorts

completed_at

Type Unknown

Description Sort by completed_at date

Required No

start_at

Type Unknown

Description Sort by start_at date

Required No

Filters

account_list_id

Type ID string

Description Filter by Account List; accepts an Account List id

Required No

activity_type

Type string

Description Filter by Action; Accepts multiple parameters, with values "Call", "Appointment", "Email", "Text Message", "Facebook Message", "Letter", "Newsletter", "Pre Call Letter", "Reminder Letter", "Support Letter", "Thank", "To Do", "Talk to In Person", or "Prayer Request"

Required No

any_tags

Type boolean

Description When filtering by tags this specifies if the filter should match tasks with any of the filtered tags if "true" or only tasks with all of the filtered tags if "false"

Required No

completed

Type boolean

Description Filter by Completed; Accepts values "true", or "false"

Required No

completed_at

Type string

Description Filter Tasks by completed at date given a date range

Required No

contact_appeal

Type string

Description Filter by Appeal; Accepts multiple parameters, with value 'no_appeals', or an appeal ID

Required No

contact_church

Type string

Description Filter by Church; Accepts multiple parameters, with value 'none', or a church name

Required No

contact_city

Type string

Description Filter by City; Accepts multiple parameters, with value 'none', or a city name

Required No

contact_country

Type string

Description Filter by Country; Accepts multiple parameters, with values 'none', or a country

Required No

contact_designation_account_id

Type string

Description Filter by Designation Account; accepts multiple parameters, separated by comma

Required No

contact_ids

Type [string]

Description Filter by Contact IDs; Accepts multiple parameters, with Contact IDs

Required No

contact_info_addr

Type string

Description Filter where contact has address; Accepts values 'Yes', or 'No'

Required No

contact_info_email

Type string

Description Filter where contact people have email addresses; Accepts values 'Yes', or 'No'

Required No

contact_info_mobile

Type string

Description Filter where contact people have mobile phones; Accepts values 'Yes', or 'No'

Required No

contact_info_phone

Type string

Description Filter where contact people have home phones; Accepts values 'Yes', or 'No'

Required No

contact_info_work_phone

Type string

Description Filter where contact people have work phones; Accepts values 'Yes', or 'No'

Required No

contact_likely

Type string

Description Filter by Likely To Give; Accepts multiple parameters, with values 'none', 'Least Likely', 'Likely', and 'Most Likely'

Required No

contact_metro_area

Type string

Description Filter by Metro Area; Accepts multiple parameters, with values 'none', or a metro area name

Required No

contact_newsletter

Type string

Description Filter by Newsletter Recipients; Accepts values 'none', 'all', 'address', 'email', and 'both'

Required No

contact_pledge_frequency

Type string

Description Filter by Pledge Frequency; Accepts multiple parameters, with numeric values like '0.23076923076923' (Weekly), '0.46153846153846' (Every 2 Weeks), '1.0' (Monthly), '2.0' (Every 2 Months), '3.0', '4.0', '6.0', '12.0' (Yearly), and '24.0' (Every 2 Years)

Required No

contact_referrer

Type string

Description Filter by Referrer; Accepts multiple parameters, with values 'none', 'any', or a Contact ID

Required No

contact_region

Type string

Description Filter by Region; Accepts multiple parameters, with values 'none', or a region name

Required No

contact_state

Type string

Description Filter by State; Accepts multiple parameters, with values 'none', or a state

Required No

contact_status

Type string

Description Filter by Status; Accepts multiple parameters, with values 'active', 'hidden', 'null', 'Never Contacted', 'Ask in Future', 'Cultivate Relationship', 'Contact for Appointment', 'Appointment Scheduled', 'Call for Decision', 'Partner - Financial', 'Partner - Special', 'Partner - Pray', 'Not Interested', 'Unresponsive', 'Never Ask', 'Research Abandoned', and 'Expired Referral'

Required No

contact_timezone

Type string

Description Filter by Timezone; Accepts multiple parameters

Required No

contact_type

Type string

Description Filter by Type; Accepts multiple parameters, with values 'person', and 'company'

Required No

created_at

Type Unknown

Description filter.created at

Required No

date_range

Type string

Description Filter by Date Range; Accepts values "last_month", "last_year", "last_two_years", "last_week", "overdue", "today", "tomorrow", "future", "upcoming" and "no_date"

Required No

exclude_tags

Type string

Description Filter tasks that have any of the tags included in this filter; comma separated value for multiple

Required No

ids

Type ID string

Description Filter tasks with ids included in this filter; comma separated value for multiple

Required No

next_action

Type string

Description Filter by Next Action; Accepts multiple parameters

Required No

overdue

Type boolean

Description Filter by overdue; Accepts values "true", or "false"

Required No

result

Type string

Description Filter by Result; Accepts multiple parameters

Required No

starred

Type boolean

Description Filter by starred; Accepts values "true", or "false"

Required No

start_at

Type string

Description Filter Tasks by start at date given a date range

Required No

tags

Type string

Description Filter by Tags; Accepts multiple parameters, with text values separated by comma

Required No

updated_at

Type date

Description Filter tasks that were updated in this date range

Required No

user_ids

Type ID string

Description Filter tasks with user_ids included in this filter; comma separated value for multiple

Required No

wildcard_search

Type string

Description Filter tasks where subject contains this filter

Required No

Response

Headers

Content-Type: application/vnd.api+json; charset=utf-8
200 OK

Body

{
  "data": [
    {
      "id": "a96f0bd7-74ad-4da2-88c1-140c88c2efce",
      "type": "tasks",
      "attributes": {
        "activity_type": "Call",
        "comments_count": 0,
        "completed": false,
        "completed_at": null,
        "created_at": "2021-11-23T14:38:05Z",
        "location": "MyString",
        "next_action": null,
        "notification_time_before": null,
        "notification_time_unit": null,
        "notification_type": null,
        "result": null,
        "starred": false,
        "start_at": "2012-03-08T14:59:46Z",
        "subject": "Call Latonya Zulauf I",
        "subject_hidden": false,
        "tag_list": [

        ],
        "updated_at": "2021-11-23T14:38:05Z",
        "updated_in_db_at": "2021-11-23T14:38:05Z"
      },
      "relationships": {
        "user": {
          "data": null
        },
        "comments": {
          "data": [

          ]
        },
        "contacts": {
          "data": [

          ]
        },
        "people": {
          "data": [

          ]
        },
        "email_addresses": {
          "data": [

          ]
        },
        "phone_numbers": {
          "data": [

          ]
        },
        "activity_contacts": {
          "data": [

          ]
        },
        "account_list": {
          "data": {
            "id": "9707d63f-3b81-4596-8068-77ed5ce4a6e2",
            "type": "account_lists"
          }
        }
      }
    }
  ],
  "meta": {
    "pagination": {
      "page": 1,
      "per_page": 25,
      "total_count": 1,
      "total_pages": 1
    },
    "sort": null,
    "filter": {
    }
  }
}

Fields

data

Type [Task]

Description An array of Task Objects

Task [POST]

Request

Endpoint

POST /api/v2/tasks
Content-Type: application/vnd.api+json

Body

{
  "data": {
    "type": "tasks",
    "attributes": {
      "activity_type": "Call",
      "completed_at": null,
      "location": "MyString",
      "result": null,
      "starred": false,
      "start_at": "2012-03-08 14:59:46",
      "subject": "Call Jeneva Lebsack",
      "updated_in_db_at": "2021-11-23 14:38:05 UTC"
    },
    "relationships": {
      "account_list": {
        "data": {
          "type": "account_lists",
          "id": "e54ca4ae-7d90-4012-a85d-449778511366"
        }
      }
    }
  }
}

Parameters

Attributes

activity_type

Type string

Description The Task activity type

Required No

comments_count

Type integer

Description The number of Task comments

Required No

completed

Type boolean

Description Whether or not the Task has been completed

Required No

completed_at

Type string

Description Task completion time

Required No

created_at

Type date

Description The timestamp of when this resource was created

Required No

location

Type string

Description The Task location

Required No

next_action

Type string

Description The next Task action

Required No

notification_time_before

Type integer

Description Notification time before

Required No

notification_time_unit

Type string

Description Unit of time for Task notification

Required No

notification_type

Type string

Description Type of notification set for Task

Required No

result

Type string

Description The result of the Task

Required No

starred

Type boolean

Description Whether or not the Task has been starred

Required No

start_at

Type string

Description Start at time for the Task

Required No

subject

Type string

Description The subject of the Task

Required No

subject_hidden

Type boolean

Description If the UI should hide the subject as it is automatically generated

Required No

tag_list

Type string

Description A list of tags associated with the Task

Required No

updated_at

Type date

Description The timestamp of when this resource was last updated

Required No

updated_in_db_at

Type date

Description This is to be used as a reference for the last time the resource was updated in the remote database - specifically for when data is updated while the client is offline.

Required No

Relationships

account_list.data

Type Account List

Description The Account List that the Task belongs to

Required No

activity_contacts.data

Type [ActivityContact]

Description An array of ActivityContact references (this joins contacts to tasks)

Required No

user.data

Type User

Description The user assigned to this contact

Required No

Response

Headers

Content-Type: application/vnd.api+json; charset=utf-8
201 Created

Body

{
  "data": {
    "id": "10768fb2-f5fe-46c5-9cf6-c68da1f145ca",
    "type": "tasks",
    "attributes": {
      "activity_type": "Call",
      "comments_count": 0,
      "completed": false,
      "completed_at": null,
      "created_at": "2021-11-23T14:38:05Z",
      "location": "MyString",
      "next_action": null,
      "notification_time_before": null,
      "notification_time_unit": null,
      "notification_type": null,
      "result": null,
      "starred": false,
      "start_at": "2012-03-08T01:59:46Z",
      "subject": "Call Jeneva Lebsack",
      "subject_hidden": false,
      "tag_list": [

      ],
      "updated_at": "2021-11-23T14:38:05Z",
      "updated_in_db_at": "2021-11-23T14:38:05Z"
    },
    "relationships": {
      "user": {
        "data": null
      },
      "comments": {
        "data": [

        ]
      },
      "contacts": {
        "data": [

        ]
      },
      "people": {
        "data": [

        ]
      },
      "email_addresses": {
        "data": [

        ]
      },
      "phone_numbers": {
        "data": [

        ]
      },
      "activity_contacts": {
        "data": [

        ]
      },
      "account_list": {
        "data": {
          "id": "e54ca4ae-7d90-4012-a85d-449778511366",
          "type": "account_lists"
        }
      }
    }
  }
}

Fields

Attributes

activity_type

Type string

Description The Task activity type

comments_count

Type integer

Description The number of Task comments

completed

Type boolean

Description Whether or not the Task has been completed

completed_at

Type string

Description Task completion time

created_at

Type date

Description The timestamp of when this resource was created

location

Type string

Description The Task location

next_action

Type string

Description The next Task action

notification_time_before

Type integer

Description Notification time before

notification_time_unit

Type string

Description Unit of time for Task notification

notification_type

Type string

Description Type of notification set for Task

result

Type string

Description The result of the Task

starred

Type boolean

Description Whether or not the Task has been starred

start_at

Type string

Description Start at time for the Task

subject

Type string

Description The subject of the Task

subject_hidden

Type boolean

Description If the UI should hide the subject as it is automatically generated

tag_list

Type string

Description A list of tags associated with the Task

updated_at

Type date

Description The timestamp of when this resource was last updated

updated_in_db_at

Type date

Description This is to be used as a reference for the last time the resource was updated in the remote database - specifically for when data is updated while the client is offline.

Relationships

account_list.data

Type Account List

Description The Account List that the Task belongs to

activity_contacts.data

Type [ActivityContact]

Description An array of ActivityContact references (this joins contacts to tasks)

comments.data

Type [Comment]

Description A list of comments associated to the Task

contacts.data

Type [Contact]

Description An array of Contact references for the Task

email_addresses.data

Type [Email Address]

Description A list of email addresses associated to the Task

people.data

Type [Person]

Description A list of people associated to the Task

phone_numbers.data

Type [Phone Number]

Description A list of phone numbers associated to the Task

user.data

Type User

Description The user assigned to this contact

Task [GET]

Request

Endpoint

GET /api/v2/tasks/c0614f8e-6aae-4cb4-9ad9-8daf61cdb65c
Content-Type: application/vnd.api+json

Body

Response

Headers

Content-Type: application/vnd.api+json; charset=utf-8
200 OK

Body

{
  "data": {
    "id": "c0614f8e-6aae-4cb4-9ad9-8daf61cdb65c",
    "type": "tasks",
    "attributes": {
      "activity_type": "Call",
      "comments_count": 0,
      "completed": false,
      "completed_at": null,
      "created_at": "2021-11-23T14:38:05Z",
      "location": "MyString",
      "next_action": null,
      "notification_time_before": null,
      "notification_time_unit": null,
      "notification_type": null,
      "result": null,
      "starred": false,
      "start_at": "2012-03-08T14:59:46Z",
      "subject": "Call Theo Effertz",
      "subject_hidden": false,
      "tag_list": [

      ],
      "updated_at": "2021-11-23T14:38:05Z",
      "updated_in_db_at": "2021-11-23T14:38:05Z"
    },
    "relationships": {
      "user": {
        "data": null
      },
      "comments": {
        "data": [

        ]
      },
      "contacts": {
        "data": [

        ]
      },
      "people": {
        "data": [

        ]
      },
      "email_addresses": {
        "data": [

        ]
      },
      "phone_numbers": {
        "data": [

        ]
      },
      "activity_contacts": {
        "data": [

        ]
      },
      "account_list": {
        "data": {
          "id": "59bbfcaa-72cc-4f9a-8ee4-b569e42fc211",
          "type": "account_lists"
        }
      }
    }
  }
}

Fields

Attributes

activity_type

Type string

Description The Task activity type

comments_count

Type integer

Description The number of Task comments

completed

Type boolean

Description Whether or not the Task has been completed

completed_at

Type string

Description Task completion time

created_at

Type date

Description The timestamp of when this resource was created

location

Type string

Description The Task location

next_action

Type string

Description The next Task action

notification_time_before

Type integer

Description Notification time before

notification_time_unit

Type string

Description Unit of time for Task notification

notification_type

Type string

Description Type of notification set for Task

result

Type string

Description The result of the Task

starred

Type boolean

Description Whether or not the Task has been starred

start_at

Type string

Description Start at time for the Task

subject

Type string

Description The subject of the Task

subject_hidden

Type boolean

Description If the UI should hide the subject as it is automatically generated

tag_list

Type string

Description A list of tags associated with the Task

updated_at

Type date

Description The timestamp of when this resource was last updated

updated_in_db_at

Type date

Description This is to be used as a reference for the last time the resource was updated in the remote database - specifically for when data is updated while the client is offline.

Relationships

account_list.data

Type Account List

Description The Account List that the Task belongs to

activity_contacts.data

Type [ActivityContact]

Description An array of ActivityContact references (this joins contacts to tasks)

comments.data

Type [Comment]

Description A list of comments associated to the Task

contacts.data

Type [Contact]

Description An array of Contact references for the Task

email_addresses.data

Type [Email Address]

Description A list of email addresses associated to the Task

people.data

Type [Person]

Description A list of people associated to the Task

phone_numbers.data

Type [Phone Number]

Description A list of phone numbers associated to the Task

user.data

Type User

Description The user assigned to this contact

Task [PUT]

Request

Endpoint

PUT /api/v2/tasks/491abacb-ed5a-4510-8c9a-cd01191ad792
Content-Type: application/vnd.api+json

Body

{
  "data": {
    "type": "tasks",
    "attributes": {
      "activity_type": "Call",
      "completed_at": null,
      "location": "MyString",
      "result": null,
      "starred": false,
      "start_at": "2012-03-08 14:59:46",
      "subject": "Call Yoko Goyette II",
      "updated_in_db_at": "2021-11-23 14:38:05 UTC"
    },
    "relationships": {
      "account_list": {
        "data": {
          "type": "account_lists",
          "id": "aa1b4633-5a6f-4df1-822f-3462873b77b7"
        }
      }
    }
  }
}

Parameters

Attributes

activity_type

Type string

Description The Task activity type

Required No

comments_count

Type integer

Description The number of Task comments

Required No

completed

Type boolean

Description Whether or not the Task has been completed

Required No

completed_at

Type string

Description Task completion time

Required No

created_at

Type date

Description The timestamp of when this resource was created

Required No

location

Type string

Description The Task location

Required No

next_action

Type string

Description The next Task action

Required No

notification_time_before

Type integer

Description Notification time before

Required No

notification_time_unit

Type string

Description Unit of time for Task notification

Required No

notification_type

Type string

Description Type of notification set for Task

Required No

overwrite

Type boolean

Description Only used for updating a record where you want to ignore the server's ' 'updated_in_db_at value and force overwrite the values for the record. ' 'Must be true to work.

Required No

result

Type string

Description The result of the Task

Required No

starred

Type boolean

Description Whether or not the Task has been starred

Required No

start_at

Type string

Description Start at time for the Task

Required No

subject

Type string

Description The subject of the Task

Required No

subject_hidden

Type boolean

Description If the UI should hide the subject as it is automatically generated

Required No

tag_list

Type string

Description A list of tags associated with the Task

Required No

updated_at

Type date

Description The timestamp of when this resource was last updated

Required No

updated_in_db_at

Type date

Description This is to be used as a reference for the last time the resource was updated in the remote database - specifically for when data is updated while the client is offline.

Required No

Relationships

account_list.data

Type Account List

Description The Account List that the Task belongs to

Required No

activity_contacts.data

Type [ActivityContact]

Description An array of ActivityContact references (this joins contacts to tasks)

Required No

user.data

Type User

Description The user assigned to this contact

Required No

Response

Headers

Content-Type: application/vnd.api+json; charset=utf-8
200 OK

Body

{
  "data": {
    "id": "491abacb-ed5a-4510-8c9a-cd01191ad792",
    "type": "tasks",
    "attributes": {
      "activity_type": "Call",
      "comments_count": 0,
      "completed": false,
      "completed_at": null,
      "created_at": "2021-11-23T14:38:05Z",
      "location": "MyString",
      "next_action": null,
      "notification_time_before": null,
      "notification_time_unit": null,
      "notification_type": null,
      "result": null,
      "starred": false,
      "start_at": "2012-03-08T01:59:46Z",
      "subject": "Call Yoko Goyette II",
      "subject_hidden": false,
      "tag_list": [

      ],
      "updated_at": "2021-11-23T14:38:05Z",
      "updated_in_db_at": "2021-11-23T14:38:05Z"
    },
    "relationships": {
      "user": {
        "data": null
      },
      "comments": {
        "data": [

        ]
      },
      "contacts": {
        "data": [

        ]
      },
      "people": {
        "data": [

        ]
      },
      "email_addresses": {
        "data": [

        ]
      },
      "phone_numbers": {
        "data": [

        ]
      },
      "activity_contacts": {
        "data": [

        ]
      },
      "account_list": {
        "data": {
          "id": "aa1b4633-5a6f-4df1-822f-3462873b77b7",
          "type": "account_lists"
        }
      }
    }
  }
}

Fields

Attributes

activity_type

Type string

Description The Task activity type

comments_count

Type integer

Description The number of Task comments

completed

Type boolean

Description Whether or not the Task has been completed

completed_at

Type string

Description Task completion time

created_at

Type date

Description The timestamp of when this resource was created

location

Type string

Description The Task location

next_action

Type string

Description The next Task action

notification_time_before

Type integer

Description Notification time before

notification_time_unit

Type string

Description Unit of time for Task notification

notification_type

Type string

Description Type of notification set for Task

result

Type string

Description The result of the Task

starred

Type boolean

Description Whether or not the Task has been starred

start_at

Type string

Description Start at time for the Task

subject

Type string

Description The subject of the Task

subject_hidden

Type boolean

Description If the UI should hide the subject as it is automatically generated

tag_list

Type string

Description A list of tags associated with the Task

updated_at

Type date

Description The timestamp of when this resource was last updated

updated_in_db_at

Type date

Description This is to be used as a reference for the last time the resource was updated in the remote database - specifically for when data is updated while the client is offline.

Relationships

account_list.data

Type Account List

Description The Account List that the Task belongs to

activity_contacts.data

Type [ActivityContact]

Description An array of ActivityContact references (this joins contacts to tasks)

comments.data

Type [Comment]

Description A list of comments associated to the Task

contacts.data

Type [Contact]

Description An array of Contact references for the Task

email_addresses.data

Type [Email Address]

Description A list of email addresses associated to the Task

people.data

Type [Person]

Description A list of people associated to the Task

phone_numbers.data

Type [Phone Number]

Description A list of phone numbers associated to the Task

user.data

Type User

Description The user assigned to this contact

Task [DELETE]

Request

Endpoint

DELETE /api/v2/tasks/c077ea0b-c824-4dd7-a305-74ea4bc69612
Content-Type: application/vnd.api+json

Body

Response

Headers

204 No Content

Body

Tasks [BULK DELETE]

Request

Endpoint

DELETE /api/v2/tasks/bulk
Content-Type: application/vnd.api+json

Body

{
  "data": [
    {
      "data": {
        "type": "tasks",
        "id": "2d0a5c60-0e10-41af-8991-668797ce4d1a"
      }
    },
    {
      "data": {
        "type": "tasks",
        "id": "ee17919a-cdba-4565-a4ec-15de8d42c46a"
      }
    }
  ]
}

Response

Headers

Content-Type: application/vnd.api+json; charset=utf-8
200 OK

Body

[
  {
    "data": {
      "id": "ee17919a-cdba-4565-a4ec-15de8d42c46a",
      "type": "tasks",
      "attributes": {
        "activity_type": "Call",
        "comments_count": 0,
        "completed": false,
        "completed_at": null,
        "created_at": "2021-11-23T14:37:34Z",
        "location": "MyString",
        "next_action": null,
        "notification_time_before": null,
        "notification_time_unit": null,
        "notification_type": null,
        "result": null,
        "starred": false,
        "start_at": "2012-03-08T14:59:46Z",
        "subject": "Call Loretta Gutkowski",
        "subject_hidden": false,
        "tag_list": [

        ],
        "updated_at": "2021-11-23T14:37:34Z",
        "updated_in_db_at": "2021-11-23T14:37:34Z"
      },
      "relationships": {
        "user": {
          "data": null
        },
        "comments": {
          "data": [

          ]
        },
        "contacts": {
          "data": [

          ]
        },
        "people": {
          "data": [

          ]
        },
        "email_addresses": {
          "data": [

          ]
        },
        "phone_numbers": {
          "data": [

          ]
        },
        "activity_contacts": {
          "data": [

          ]
        },
        "account_list": {
          "data": {
            "id": "2d8c57a2-fda8-4016-a5e6-30b725a2cd1b",
            "type": "account_lists"
          }
        }
      }
    }
  },
  {
    "data": {
      "id": "2d0a5c60-0e10-41af-8991-668797ce4d1a",
      "type": "tasks",
      "attributes": {
        "activity_type": "Call",
        "comments_count": 0,
        "completed": false,
        "completed_at": null,
        "created_at": "2021-11-23T14:37:34Z",
        "location": "MyString",
        "next_action": null,
        "notification_time_before": null,
        "notification_time_unit": null,
        "notification_type": null,
        "result": null,
        "starred": false,
        "start_at": "2012-03-08T14:59:46Z",
        "subject": "Call Leo Durgan",
        "subject_hidden": false,
        "tag_list": [

        ],
        "updated_at": "2021-11-23T14:37:34Z",
        "updated_in_db_at": "2021-11-23T14:37:34Z"
      },
      "relationships": {
        "user": {
          "data": null
        },
        "comments": {
          "data": [

          ]
        },
        "contacts": {
          "data": [

          ]
        },
        "people": {
          "data": [

          ]
        },
        "email_addresses": {
          "data": [

          ]
        },
        "phone_numbers": {
          "data": [

          ]
        },
        "activity_contacts": {
          "data": [

          ]
        },
        "account_list": {
          "data": {
            "id": "2d8c57a2-fda8-4016-a5e6-30b725a2cd1b",
            "type": "account_lists"
          }
        }
      }
    }
  }
]

Fields

data

Type [Task]

Description An array of Tasks that have just been deleted

Tasks [BULK POST]

Request

Endpoint

POST /api/v2/tasks/bulk
Content-Type: application/vnd.api+json

Body

{
  "data": [
    {
      "data": {
        "type": "tasks",
        "id": "96e4af8a-3642-4595-a780-7b2512f086d0",
        "attributes": {
          "starred": false,
          "location": "MyString",
          "subject": "Call Msgr. Kym Pagac",
          "start_at": "2012-03-08 14:59:46",
          "activity_type": "Call",
          "result": null,
          "completed_at": null,
          "updated_in_db_at": "2021-11-23 14:37:34 UTC"
        },
        "relationships": {
          "account_list": {
            "data": {
              "id": "649986e1-6916-4c75-b8dc-33e03d17a299",
              "type": "account_lists"
            }
          }
        }
      }
    }
  ]
}

Response

Headers

Content-Type: application/vnd.api+json; charset=utf-8
200 OK

Body

[
  {
    "data": {
      "id": "96e4af8a-3642-4595-a780-7b2512f086d0",
      "type": "tasks",
      "attributes": {
        "activity_type": "Call",
        "comments_count": 0,
        "completed": false,
        "completed_at": null,
        "created_at": "2021-11-23T14:37:34Z",
        "location": "MyString",
        "next_action": null,
        "notification_time_before": null,
        "notification_time_unit": null,
        "notification_type": null,
        "result": null,
        "starred": false,
        "start_at": "2012-03-08T01:59:46Z",
        "subject": "Call Msgr. Kym Pagac",
        "subject_hidden": false,
        "tag_list": [

        ],
        "updated_at": "2021-11-23T14:37:34Z",
        "updated_in_db_at": "2021-11-23T14:37:34Z"
      },
      "relationships": {
        "user": {
          "data": null
        },
        "comments": {
          "data": [

          ]
        },
        "contacts": {
          "data": [

          ]
        },
        "people": {
          "data": [

          ]
        },
        "email_addresses": {
          "data": [

          ]
        },
        "phone_numbers": {
          "data": [

          ]
        },
        "activity_contacts": {
          "data": [

          ]
        },
        "account_list": {
          "data": {
            "id": "649986e1-6916-4c75-b8dc-33e03d17a299",
            "type": "account_lists"
          }
        }
      }
    }
  }
]

Fields

data

Type [Task / error]

Description List of Task objects that have been successfully updated and list of errors related to Task objects that were not updated successfully

Tasks [BULK PUT]

Request

Endpoint

PUT /api/v2/tasks/bulk
Content-Type: application/vnd.api+json

Body

{
  "data": [
    {
      "data": {
        "type": "tasks",
        "id": "9dab939e-9b79-4285-815c-799a117fdbf1",
        "attributes": {
          "starred": false,
          "location": "MyString",
          "subject": "Call Geoffrey Miller",
          "start_at": "2012-03-08 14:59:46",
          "activity_type": "Call",
          "result": null,
          "completed_at": null,
          "updated_in_db_at": "2021-11-23 14:37:34 UTC"
        }
      }
    }
  ]
}

Response

Headers

Content-Type: application/vnd.api+json; charset=utf-8
200 OK

Body

[
  {
    "data": {
      "id": "9dab939e-9b79-4285-815c-799a117fdbf1",
      "type": "tasks",
      "attributes": {
        "activity_type": "Call",
        "comments_count": 0,
        "completed": false,
        "completed_at": null,
        "created_at": "2021-11-23T14:37:34Z",
        "location": "MyString",
        "next_action": null,
        "notification_time_before": null,
        "notification_time_unit": null,
        "notification_type": null,
        "result": null,
        "starred": false,
        "start_at": "2012-03-08T01:59:46Z",
        "subject": "Call Geoffrey Miller",
        "subject_hidden": false,
        "tag_list": [

        ],
        "updated_at": "2021-11-23T14:37:34Z",
        "updated_in_db_at": "2021-11-23T14:37:34Z"
      },
      "relationships": {
        "user": {
          "data": null
        },
        "comments": {
          "data": [

          ]
        },
        "contacts": {
          "data": [

          ]
        },
        "people": {
          "data": [

          ]
        },
        "email_addresses": {
          "data": [

          ]
        },
        "phone_numbers": {
          "data": [

          ]
        },
        "activity_contacts": {
          "data": [

          ]
        },
        "account_list": {
          "data": {
            "id": "29eded29-90d1-4c3d-b45f-0968dd441578",
            "type": "account_lists"
          }
        }
      }
    }
  }
]

Fields

data

Type [Task / error]

Description Array of both Task objects that have been successfully updated and of errors related to Contact objects that were not updated successfully

PreviousYear Donations NextAnalytics

Last updated 2 years ago