POST
/
api
/
v1
/
collection-records
/
activity-list

​
Description

This API endpoint facilitates the creation of an activity or task within a specified collection. The activity can be associated with a collection record and is defined by various parameters provided in the request body.

​
Body

​
iconType
string
required

Specifies the type of icon associated with the activity. Possible values include ‘emoji’, ‘interaction’, ‘messaging_app’, etc.

​
iconValue
string
required

Defines the specific value of the icon based on the iconType.

  • For ‘emoji’, provide any emoji.
  • For ‘interaction’, valid values include ‘call’, ‘meeting’, ‘message’, ‘coffee’, ‘lunch’, ‘event’, ‘drink’, etc.
  • For ‘messaging_app’, valid values include ‘whatsapp’, ‘twitter’, ‘linkedin’, ‘hangout’, ‘skype’, ‘slack’, ‘imessage’, ‘facebook_messenger’, ‘signal’, ‘discord’, ‘wechat’, ‘telegram’, ‘viber’, etc.
​
name
string
required

The name or title of the activity.

​
scheduleAt
string
required

Specifies the scheduled time for the activity in the format “YYYY-MM-DDTHH:mm:ss.SSSZ”.

​
description
string

A description providing additional details about the activity.

​
associated
string

The ID of the collection record associated with the activity.

​
status
string

The ID of the status attribute indicating the current status of the activity.

​
Response

​
status
boolean

Indicates the success or failure of the activity creation. In this case, true signifies a successful operation.

​
message
string

Provides a human-readable message accompanying the response. In this instance, it confirms the successful creation of the activity with the message “Record created successfully!”

​
_id
string

The unique identifier for the created activity.

​
data
object

An object containing details of the created activity.

Get Activity By IdUpdate An Activity