Back to Teamwork CRMComplete or incomplete activity
Completes or incomplete activity depending on the current state
The following values are allowed in the include query parameter:
- activityType
- assignees
- contacts
- email-connections
Input
type: object
properties:
parameters:
type: object
properties:
include:
type: string
description: |-
Comma separated list of relationships to include in the response.
See
[including related entities](/crm/general/related-entities)
for more detailed documentation of how this works.
id:
type: integer
required:
- id
title: Parameters
Output
type: object
title: activityResponse
properties:
activity:
type: object
title: Activity
properties:
activityType:
type: object
properties:
id:
type: integer
description: The id related entity.
type:
type: string
description: The type of the related entity, e.g "users".
assignees:
type: array
description: >-
[To-many relationship
array](/crm/general/entity-models#to-many-relationships) which
describes a list of resource identifier objects.
items:
type: object
properties:
id:
type: integer
description: The id related entity.
type:
type: string
description: The type of the related entity, e.g "users".
assigneesCount:
type: integer
description: Number of users assigned to the activity.
completedAt:
type: string
format: date-time
completedByUser:
type: object
properties:
id:
type: integer
description: The id related entity.
type:
type: string
description: The type of the related entity, e.g "users".
contacts:
type: array
description: >-
[To-many relationship
array](/crm/general/entity-models#to-many-relationships) which
describes a list of resource identifier objects.
items:
type: object
properties:
id:
type: integer
description: The id related entity.
type:
type: string
description: The type of the related entity, e.g "users".
contactsCount:
type: integer
description: Number of contacts connected to the activity.
createdAt:
type: string
description: When the item was created, as a datetime
format: date-time
createdBy:
type: object
properties:
id:
type: integer
type:
type: string
enum:
- users
custom:
type: object
deal:
type: object
properties:
id:
type: integer
description: The id related entity.
type:
type: string
description: The type of the related entity, e.g "users".
deletedAt:
type: string
description: When the item was deleted, as a datetime
format: date-time
deletedBy:
type: object
properties:
id:
type: integer
type:
type: string
enum:
- users
description:
type: string
dueDate:
type: string
description: The duration added to the startDate.
format: date-time
duration:
type: integer
description: Duration in minutes of how long the activity will take to complete.
id:
type: integer
isAllDay:
type: boolean
isComplete:
type: boolean
reminders:
type: array
description: Reminders for the activity.
items:
type: object
title: ActivityReminder
properties:
id:
type: integer
receivers:
type: array
description: >-
[To-many relationship
array](/crm/general/entity-models#to-many-relationships) which
describes a list of resource identifier objects.
items:
type: object
properties:
id:
type: integer
description: The id related entity.
type:
type: string
description: The type of the related entity, e.g "users".
time:
type: integer
description: Time before the activity dueDate the reminder will be sent.
timeUnit:
type: string
description: Time unit of the reminder.
enum:
- minutes
- hours
- days
startDate:
type: string
format: date-time
title:
type: string
updatedAt:
type: string
description: When the item was last updated, as a datetime
format: date-time
updatedBy:
type: object
properties:
id:
type: integer
type:
type: string
enum:
- users
updatedSourceId:
type: integer
description: Source ID of the latest request made (API / Web app)
included:
type: object
title: Included