POST /crm/tasks
Create a new CRM task with the specified name, type, due date, and optional associations to contacts, companies, or deals. A task requires a name, task type ID, and due date at minimum. You can also set a duration, notes, a reminder, and assign the task to a specific user.
Servers
- https://api.brevo.com/v3
Request headers
| Name | Type | Required | Description |
|---|---|---|---|
Content-Type |
String | Yes |
The media type of the request body.
Default value: "application/json" |
Request body fields
| Name | Type | Required | Description |
|---|---|---|---|
companiesIds[] |
Array | No |
Companies ids for companies a task is linked to |
reminder |
Object | No |
Task reminder date/time for a task |
reminder.types[] |
Array | Yes |
Type of task reminder e.g email, push |
reminder.value |
Integer | Yes |
Value of time unit before reminder is to be sent |
reminder.unit |
String | Yes |
Unit of time before reminder is to be sent Valid values:
|
name |
String | Yes |
Name of task |
notes |
String | No |
Notes added to a task |
taskTypeId |
String | Yes |
Id for type of task e.g Call / Email / Meeting etc. |
contactsIds[] |
Array | No |
Contact ids for contacts linked to this task |
done |
Boolean | No |
Task marked as done |
assignToId |
String | No |
To assign a task to a user you can use either the account email or ID. |
date |
String | Yes |
Task due date and time |
duration |
Integer | No |
Duration of task in milliseconds [1 minute = 60000 ms] |
dealsIds[] |
Array | No |
Deal ids for deals a task is linked to |
How to start integrating
- Add HTTP Task to your workflow definition.
- Search for the API you want to integrate with and click on the name.
- This loads the API reference documentation and prepares the Http request settings.
- Click Test request to test run your request to the API and see the API's response.