Tags

Tags Documentation

Tag [LIST]

Tag [LIST]

Request

Endpoint

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

Body

Parameters

Filters

account_list_id

Type ID string

Description The ID of an Account List to scope the tasks to

Required No

Response

Headers

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

Body

{
  "data": [
    {
      "id": "366ade64-92a8-406f-856d-54f0f6fdbb4d",
      "type": "tags",
      "attributes": {
        "name": "new_tag"
      }
    }
  ]
}

Fields

data

Type [Tag]

Description An array of Tags

Tag [POST]

Tag [POST]

Request

Endpoint

POST /api/v2/tasks/ff907288-8891-478b-98d6-dfe3601f9717/tags
Content-Type: application/vnd.api+json

Body

{
  "data": {
    "type": "tags",
    "attributes": {
      "name": "new_tag"
    }
  }
}

Parameters

Attributes

name

Type string

Description The name of tag

Required No

Response

Headers

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

Body

{
  "data": {
    "id": "ff907288-8891-478b-98d6-dfe3601f9717",
    "type": "tasks",
    "attributes": {
      "activity_type": "Call",
      "comments_count": 0,
      "completed": false,
      "completed_at": null,
      "created_at": "2022-01-12T17:18:51Z",
      "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 Melani Feil Ret.",
      "subject_hidden": false,
      "tag_list": [
        "new_tag"
      ],
      "updated_at": "2022-01-12T17:18:51Z",
      "updated_in_db_at": "2022-01-12T17:18:51Z"
    },
    "relationships": {
      "user": {
        "data": null
      },
      "comments": {
        "data": [

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

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

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

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

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

        ]
      },
      "account_list": {
        "data": {
          "id": "c7fa0aad-a0c8-42bf-82fb-e3d943a3e027",
          "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 task

Tag [DELETE]

Tag [DELETE]

Request

Endpoint

DELETE /api/v2/tasks/7c6e2f5a-f033-43a0-a1b1-15eb67c79bc4/tags/new_tag
Content-Type: application/vnd.api+json

Body

Response

Headers

204 No Content

Body

Tags [BULK CREATE]

Tags [BULK POST]

Request

Endpoint

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

Body

{
  "data": [
    {
      "data": {
        "type": "tags",
        "attributes": {
          "name": "tag_one"
        }
      }
    },
    {
      "data": {
        "type": "tags",
        "attributes": {
          "name": "tag_two"
        }
      }
    }
  ],
  "filter": {
    "task_ids": "001e6805-4bfe-4b6f-b571-891b16d59a63, 339b1590-3502-4acd-bbdb-c0ea47a38269"
  }
}

Parameters

Filters

account_list_id

Type ID string

Description The ID of an Account List to scope the tasks to

Required No

task_ids

Type string (comma delimited IDs)

Description A comma delimited list of Task IDs to add the Tag to. If ommited the Tag will be added to all Tasks.

Required No

Attributes

name

Type string

Description The name of the Tag to be added

Required No

Response

Headers

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

Body

[
  {
    "data": {
      "id": "001e6805-4bfe-4b6f-b571-891b16d59a63",
      "type": "tasks",
      "attributes": {
        "activity_type": "Call",
        "comments_count": 0,
        "completed": false,
        "completed_at": null,
        "created_at": "2022-01-12T17:18:42Z",
        "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 Aisha Bartoletti",
        "subject_hidden": false,
        "tag_list": [
          "tag_one",
          "tag_two"
        ],
        "updated_at": "2022-01-12T17:18:42Z",
        "updated_in_db_at": "2022-01-12T17:18:42Z"
      },
      "relationships": {
        "user": {
          "data": null
        },
        "comments": {
          "data": [

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

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

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

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

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

          ]
        },
        "account_list": {
          "data": {
            "id": "5629fb98-fdcb-4f00-816f-e74ad8800c86",
            "type": "account_lists"
          }
        }
      }
    }
  },
  {
    "data": {
      "id": "339b1590-3502-4acd-bbdb-c0ea47a38269",
      "type": "tasks",
      "attributes": {
        "activity_type": "Call",
        "comments_count": 0,
        "completed": false,
        "completed_at": null,
        "created_at": "2022-01-12T17:18:42Z",
        "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 Verlene Legros",
        "subject_hidden": false,
        "tag_list": [
          "tag_one",
          "tag_three",
          "tag_two"
        ],
        "updated_at": "2022-01-12T17:18:42Z",
        "updated_in_db_at": "2022-01-12T17:18:42Z"
      },
      "relationships": {
        "user": {
          "data": null
        },
        "comments": {
          "data": [

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

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

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

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

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

          ]
        },
        "account_list": {
          "data": {
            "id": "5629fb98-fdcb-4f00-816f-e74ad8800c86",
            "type": "account_lists"
          }
        }
      }
    }
  }
]

Fields

Attributes

created_at

Type date

Description The timestamp of when this resource was created

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.

Tags [BULK DELETE]

Tags [BULK DELETE]

Request

Endpoint

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

Body

{
  "data": [
    {
      "data": {
        "type": "tags",
        "attributes": {
          "name": "tag_one"
        }
      }
    },
    {
      "data": {
        "type": "tags",
        "attributes": {
          "name": "tag_two"
        }
      }
    }
  ],
  "filter": {
    "task_ids": "59ac6341-d443-4706-8d83-f887af63c902, 6f00b1a1-44c6-4fdb-8bc2-33590ab39c31"
  }
}

Parameters

Filters

account_list_id

Type ID string

Description The ID of an Account List to scope the tasks to

Required No

task_ids

Type string (comma delimited IDs)

Description A comma delimited list of Task IDs to remove the Tag from. If ommited the Tag will be removed from all Tasks.

Required No

Attributes

name

Type string

Description The name of the Tag to be deleted

Required No

Response

Headers

204 No Content

Body