Skip to main content
POST
Create An Activity

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

string
required
Specifies the type of icon associated with the activity. Possible values include ‘emoji’, ‘interaction’, ‘messaging_app’, etc.
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.
string
required
The name or title of the activity.
string
required
Specifies the scheduled time for the activity in the format “YYYY-MM-DDTHH:mm:ss.SSSZ”.
string
A description providing additional details about the activity.
string
The ID of the collection record associated with the activity.
string
The ID of the status attribute indicating the current status of the activity.

Response

boolean
Indicates the success or failure of the activity creation. In this case, true signifies a successful operation.
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!”
string
The unique identifier for the created activity.
object
An object containing details of the created activity.