Create A List Entry
curl --request POST \
--url https://api.zixflow.com/api/v1/list-entries/{listId} \
--header 'Authorization: <authorization>' \
--header 'Content-Type: application/json' \
--data '{
"recordId": "<string>",
"data": {}
}'
{
"status": true,
"message": "List entry created successfully!",
"data": {
"listId": "6551fdcad2d75edff28c9085",
"peopleId": "654566f0c57bc82e28e5bb40",
"companyId": null,
"dealId": null,
"recordId": null,
"owner": "63d0e0b2eaa35b73f3b2344e",
"_id": "6551fe0c92dc3d7c3aa20e12",
"createdAt": "2023-11-13T10:44:28.028Z",
"updatedAt": "2023-11-13T10:44:28.028Z",
"__v": 0
<!-- Additional fields based on list attributes -->
}
}
Description
This API endpoint allows the creation of a new entry within a specified list. The list entry is associated with a collection record, and additional data can be provided based on the attributes of the list.
Path
A unique identifier for the list where the new entry will be added.
Body
The ID of the collection record to be linked with the list entry.
Key-value pairs representing data for the list entry. Keys are defined by the attribute API key name, and values are based on the input type of the attribute.
Response
Indicates the success or failure of the list entry creation. In this case, true signifies a successful operation.
Provides a human-readable message accompanying the response. In this instance, it confirms the successful creation of the list entry with the message “List entry created successfully!”
An object containing details of the created list entry. The structure of the data object is dynamic and depends on the attributes supported by the list:
curl --request POST \
--url https://api.zixflow.com/api/v1/list-entries/{listId} \
--header 'Authorization: <authorization>' \
--header 'Content-Type: application/json' \
--data '{
"recordId": "<string>",
"data": {}
}'
{
"status": true,
"message": "List entry created successfully!",
"data": {
"listId": "6551fdcad2d75edff28c9085",
"peopleId": "654566f0c57bc82e28e5bb40",
"companyId": null,
"dealId": null,
"recordId": null,
"owner": "63d0e0b2eaa35b73f3b2344e",
"_id": "6551fe0c92dc3d7c3aa20e12",
"createdAt": "2023-11-13T10:44:28.028Z",
"updatedAt": "2023-11-13T10:44:28.028Z",
"__v": 0
<!-- Additional fields based on list attributes -->
}
}