POST
/
api
/
v1
/
collection-records
/
activity-list
curl --request POST \
  --url https://api.zixflow.com/api/v1/collection-records/activity-list \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '{
  "iconType": "<string>",
  "iconValue": "<string>",
  "name": "<string>",
  "scheduleAt": "<string>",
  "description": "<string>",
  "associated": "<string>",
  "status": "<string>"
}'
{
    "status": true,
    "message": "Record created successfully!",
    "_id": "655c081eb3b96854c04e621a",
    "data": {
        "_id": "655c081eb3b96854c04e621a",
        "name": "Test Activity",
        "scheduleAt": "2023-12-01T00:00:00.000Z",
        "description": "Testing",
        "associated": null,
        "assignee": null,
        "status": {
            "_id": "65338d9cf781c59be3859c62",
            "color": "#9898fa",
            "name": "Open",
            "celebrationEnabled": false,
            "isArchived": false,
            "order": 1,
            "statusType": "normal",
            "timeInStatus": 0
        },
        "sourceDetails": "",
        "source": {
            "_id": "65338d9cf781c59be3859c6b",
            "name": "API",
            "color": "#dbeddb",
            "isArchived": false,
            "order": 2
        },
        "createdBy": {
            "_id": "65338d9a4d3b7a624a8d63ab",
            "name": "Test user",
            "avatar": "",
            "email": "user@zixflow.com"
        },
        "completedTime": false,
        "activityLostReason": null,
        "createdAt": "2023-11-21T01:30:06.242Z"
    }
}

​
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