curl --request POST \
--url https://production-api.joinrings.com/v1/tasks \
--header 'Content-Type: application/json' \
--header 'x-api-key: <api-key>' \
--data '
{
"title": "<string>",
"assigned_to_uuids": [
"<string>"
],
"associated_entity_type": "<string>",
"associated_entity_uuids": [
"<string>"
],
"content": {},
"due_date": "<string>",
"reminder_value": 123,
"visibility": "RING"
}
'import requests
url = "https://production-api.joinrings.com/v1/tasks"
payload = {
"title": "<string>",
"assigned_to_uuids": ["<string>"],
"associated_entity_type": "<string>",
"associated_entity_uuids": ["<string>"],
"content": {},
"due_date": "<string>",
"reminder_value": 123,
"visibility": "RING"
}
headers = {
"x-api-key": "<api-key>",
"Content-Type": "application/json"
}
response = requests.post(url, json=payload, headers=headers)
print(response.text)const options = {
method: 'POST',
headers: {'x-api-key': '<api-key>', 'Content-Type': 'application/json'},
body: JSON.stringify({
title: '<string>',
assigned_to_uuids: ['<string>'],
associated_entity_type: '<string>',
associated_entity_uuids: ['<string>'],
content: {},
due_date: '<string>',
reminder_value: 123,
visibility: 'RING'
})
};
fetch('https://production-api.joinrings.com/v1/tasks', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));<?php
$curl = curl_init();
curl_setopt_array($curl, [
CURLOPT_URL => "https://production-api.joinrings.com/v1/tasks",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "POST",
CURLOPT_POSTFIELDS => json_encode([
'title' => '<string>',
'assigned_to_uuids' => [
'<string>'
],
'associated_entity_type' => '<string>',
'associated_entity_uuids' => [
'<string>'
],
'content' => [
],
'due_date' => '<string>',
'reminder_value' => 123,
'visibility' => 'RING'
]),
CURLOPT_HTTPHEADER => [
"Content-Type: application/json",
"x-api-key: <api-key>"
],
]);
$response = curl_exec($curl);
$err = curl_error($curl);
curl_close($curl);
if ($err) {
echo "cURL Error #:" . $err;
} else {
echo $response;
}package main
import (
"fmt"
"strings"
"net/http"
"io"
)
func main() {
url := "https://production-api.joinrings.com/v1/tasks"
payload := strings.NewReader("{\n \"title\": \"<string>\",\n \"assigned_to_uuids\": [\n \"<string>\"\n ],\n \"associated_entity_type\": \"<string>\",\n \"associated_entity_uuids\": [\n \"<string>\"\n ],\n \"content\": {},\n \"due_date\": \"<string>\",\n \"reminder_value\": 123,\n \"visibility\": \"RING\"\n}")
req, _ := http.NewRequest("POST", url, payload)
req.Header.Add("x-api-key", "<api-key>")
req.Header.Add("Content-Type", "application/json")
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(string(body))
}HttpResponse<String> response = Unirest.post("https://production-api.joinrings.com/v1/tasks")
.header("x-api-key", "<api-key>")
.header("Content-Type", "application/json")
.body("{\n \"title\": \"<string>\",\n \"assigned_to_uuids\": [\n \"<string>\"\n ],\n \"associated_entity_type\": \"<string>\",\n \"associated_entity_uuids\": [\n \"<string>\"\n ],\n \"content\": {},\n \"due_date\": \"<string>\",\n \"reminder_value\": 123,\n \"visibility\": \"RING\"\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://production-api.joinrings.com/v1/tasks")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Post.new(url)
request["x-api-key"] = '<api-key>'
request["Content-Type"] = 'application/json'
request.body = "{\n \"title\": \"<string>\",\n \"assigned_to_uuids\": [\n \"<string>\"\n ],\n \"associated_entity_type\": \"<string>\",\n \"associated_entity_uuids\": [\n \"<string>\"\n ],\n \"content\": {},\n \"due_date\": \"<string>\",\n \"reminder_value\": 123,\n \"visibility\": \"RING\"\n}"
response = http.request(request)
puts response.read_body{
"id": "<string>",
"created_at": "<string>",
"updated_at": "<string>"
}Create a task
Creates a task and optionally assigns it to users and associates it with entities (persons, companies, opportunities, etc.) in a single atomic operation. Returns the new task id on success.
Enum values (case-sensitive, uppercase):
- status: DRAFT | ACTIVE | COMPLETED | ARCHIVED (default: ACTIVE)
- priority: LOW | MEDIUM | HIGH
- visibility: RING (all tenant members) | PERSONAL (creator only, default: RING)
- reminder_type: MINUTES | HOURS | DAYS | WEEKS (requires reminder_value)
curl --request POST \
--url https://production-api.joinrings.com/v1/tasks \
--header 'Content-Type: application/json' \
--header 'x-api-key: <api-key>' \
--data '
{
"title": "<string>",
"assigned_to_uuids": [
"<string>"
],
"associated_entity_type": "<string>",
"associated_entity_uuids": [
"<string>"
],
"content": {},
"due_date": "<string>",
"reminder_value": 123,
"visibility": "RING"
}
'import requests
url = "https://production-api.joinrings.com/v1/tasks"
payload = {
"title": "<string>",
"assigned_to_uuids": ["<string>"],
"associated_entity_type": "<string>",
"associated_entity_uuids": ["<string>"],
"content": {},
"due_date": "<string>",
"reminder_value": 123,
"visibility": "RING"
}
headers = {
"x-api-key": "<api-key>",
"Content-Type": "application/json"
}
response = requests.post(url, json=payload, headers=headers)
print(response.text)const options = {
method: 'POST',
headers: {'x-api-key': '<api-key>', 'Content-Type': 'application/json'},
body: JSON.stringify({
title: '<string>',
assigned_to_uuids: ['<string>'],
associated_entity_type: '<string>',
associated_entity_uuids: ['<string>'],
content: {},
due_date: '<string>',
reminder_value: 123,
visibility: 'RING'
})
};
fetch('https://production-api.joinrings.com/v1/tasks', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));<?php
$curl = curl_init();
curl_setopt_array($curl, [
CURLOPT_URL => "https://production-api.joinrings.com/v1/tasks",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "POST",
CURLOPT_POSTFIELDS => json_encode([
'title' => '<string>',
'assigned_to_uuids' => [
'<string>'
],
'associated_entity_type' => '<string>',
'associated_entity_uuids' => [
'<string>'
],
'content' => [
],
'due_date' => '<string>',
'reminder_value' => 123,
'visibility' => 'RING'
]),
CURLOPT_HTTPHEADER => [
"Content-Type: application/json",
"x-api-key: <api-key>"
],
]);
$response = curl_exec($curl);
$err = curl_error($curl);
curl_close($curl);
if ($err) {
echo "cURL Error #:" . $err;
} else {
echo $response;
}package main
import (
"fmt"
"strings"
"net/http"
"io"
)
func main() {
url := "https://production-api.joinrings.com/v1/tasks"
payload := strings.NewReader("{\n \"title\": \"<string>\",\n \"assigned_to_uuids\": [\n \"<string>\"\n ],\n \"associated_entity_type\": \"<string>\",\n \"associated_entity_uuids\": [\n \"<string>\"\n ],\n \"content\": {},\n \"due_date\": \"<string>\",\n \"reminder_value\": 123,\n \"visibility\": \"RING\"\n}")
req, _ := http.NewRequest("POST", url, payload)
req.Header.Add("x-api-key", "<api-key>")
req.Header.Add("Content-Type", "application/json")
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(string(body))
}HttpResponse<String> response = Unirest.post("https://production-api.joinrings.com/v1/tasks")
.header("x-api-key", "<api-key>")
.header("Content-Type", "application/json")
.body("{\n \"title\": \"<string>\",\n \"assigned_to_uuids\": [\n \"<string>\"\n ],\n \"associated_entity_type\": \"<string>\",\n \"associated_entity_uuids\": [\n \"<string>\"\n ],\n \"content\": {},\n \"due_date\": \"<string>\",\n \"reminder_value\": 123,\n \"visibility\": \"RING\"\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://production-api.joinrings.com/v1/tasks")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Post.new(url)
request["x-api-key"] = '<api-key>'
request["Content-Type"] = 'application/json'
request.body = "{\n \"title\": \"<string>\",\n \"assigned_to_uuids\": [\n \"<string>\"\n ],\n \"associated_entity_type\": \"<string>\",\n \"associated_entity_uuids\": [\n \"<string>\"\n ],\n \"content\": {},\n \"due_date\": \"<string>\",\n \"reminder_value\": 123,\n \"visibility\": \"RING\"\n}"
response = http.request(request)
puts response.read_body{
"id": "<string>",
"created_at": "<string>",
"updated_at": "<string>"
}Authorizations
Body
List of internal user UUIDs to assign the task to.
Entity type for associated_entity_uuids. Must be one of: PERSON, COMPANY, NOTE, FILE, OPPORTUNITY.
List of entity UUIDs (persons, companies, etc.) to associate with the task.
ISO 8601 date string, e.g. '2025-12-31'.
Task priority. Must be one of: LOW, MEDIUM, HIGH. Omit to leave unset.
LOW, MEDIUM, HIGH Unit for the reminder interval. Must be one of: MINUTES, HOURS, DAYS, WEEKS. Requires reminder_value to be set together.
MINUTES, HOURS, DAYS, WEEKS Numeric amount for the reminder interval (e.g. 30 for 30 minutes).
Task status. Must be one of: DRAFT (not yet started), ACTIVE (in progress), COMPLETED (done), ARCHIVED (soft-deleted from view). Defaults to ACTIVE when omitted on create.
DRAFT, ACTIVE, COMPLETED, ARCHIVED Visibility scope. RING = visible to all tenant members; PERSONAL = visible only to the creator. Defaults to RING.
RING, PERSONAL