POST
/
api
/
v1
/
collection-records
/
{collectionId}
Create A Collection Record
curl --request POST \
  --url https://api.zixflow.com/api/v1/collection-records/{collectionId} \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '{
  "<key>": {}
}'
{
    "status": true,
    "message": "Record created successfully!",
    "_id": "6551f5ff3c896c334f28d659",
    "data": {
        "_id": "6551f5ff3c896c334f28d659",
        "<key>": "<value>"
    }
}

Description

This API endpoint enables the creation of a new collection record within a specified collection. The collection record is associated with the provided collection ID.

Path

collectionId
string
required
A unique identifier for the collection where the record will be added.

Body

<key>
varies
required
Key-value pairs representing data for the collection record. Keys are defined by the attribute API key name, and values depend on the input type of the attribute.

Response

status
boolean
Indicates the success or failure of the collection record 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 collection record with the message “Record created successfully!”
_id
string
The unique identifier for the created collection record.
data
object
An object containing details of the created collection record, including key-value pairs representing the record’s data.
{
    "status": true,
    "message": "Record created successfully!",
    "_id": "6551f5ff3c896c334f28d659",
    "data": {
        "_id": "6551f5ff3c896c334f28d659",
        "<key>": "<value>"
    }
}