Skip to main content
PATCH
/
reminders
/
{id}
Update a reminder
curl --request PATCH \
  --url https://api.breakcold.com/rest/reminders/{id} \
  --header 'Content-Type: application/json' \
  --header 'X-API-KEY: <api-key>' \
  --data '
{
  "id_lead": "<string>",
  "name": "<string>",
  "date": "2023-11-07T05:31:56Z",
  "cron": "<string>",
  "is_done": true,
  "users": [
    "<string>"
  ]
}
'
import requests

url = "https://api.breakcold.com/rest/reminders/{id}"

payload = {
"id_lead": "<string>",
"name": "<string>",
"date": "2023-11-07T05:31:56Z",
"cron": "<string>",
"is_done": True,
"users": ["<string>"]
}
headers = {
"X-API-KEY": "<api-key>",
"Content-Type": "application/json"
}

response = requests.patch(url, json=payload, headers=headers)

print(response.text)
const options = {
method: 'PATCH',
headers: {'X-API-KEY': '<api-key>', 'Content-Type': 'application/json'},
body: JSON.stringify({
id_lead: '<string>',
name: '<string>',
date: '2023-11-07T05:31:56Z',
cron: '<string>',
is_done: true,
users: ['<string>']
})
};

fetch('https://api.breakcold.com/rest/reminders/{id}', 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://api.breakcold.com/rest/reminders/{id}",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "PATCH",
CURLOPT_POSTFIELDS => json_encode([
'id_lead' => '<string>',
'name' => '<string>',
'date' => '2023-11-07T05:31:56Z',
'cron' => '<string>',
'is_done' => true,
'users' => [
'<string>'
]
]),
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://api.breakcold.com/rest/reminders/{id}"

payload := strings.NewReader("{\n \"id_lead\": \"<string>\",\n \"name\": \"<string>\",\n \"date\": \"2023-11-07T05:31:56Z\",\n \"cron\": \"<string>\",\n \"is_done\": true,\n \"users\": [\n \"<string>\"\n ]\n}")

req, _ := http.NewRequest("PATCH", 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.patch("https://api.breakcold.com/rest/reminders/{id}")
.header("X-API-KEY", "<api-key>")
.header("Content-Type", "application/json")
.body("{\n \"id_lead\": \"<string>\",\n \"name\": \"<string>\",\n \"date\": \"2023-11-07T05:31:56Z\",\n \"cron\": \"<string>\",\n \"is_done\": true,\n \"users\": [\n \"<string>\"\n ]\n}")
.asString();
require 'uri'
require 'net/http'

url = URI("https://api.breakcold.com/rest/reminders/{id}")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Patch.new(url)
request["X-API-KEY"] = '<api-key>'
request["Content-Type"] = 'application/json'
request.body = "{\n \"id_lead\": \"<string>\",\n \"name\": \"<string>\",\n \"date\": \"2023-11-07T05:31:56Z\",\n \"cron\": \"<string>\",\n \"is_done\": true,\n \"users\": [\n \"<string>\"\n ]\n}"

response = http.request(request)
puts response.read_body
{
  "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "date": "<string>",
  "name": "<string>",
  "cron": "<string>",
  "cron_id": "<string>",
  "created_at": "<string>",
  "updated_at": "<string>",
  "is_deleted": true,
  "is_done": true,
  "ressource_link": "<string>",
  "ai_generated": true,
  "ai_action_channel": "<string>",
  "ai_action_description": "<string>",
  "ai_action_priority": "<string>",
  "ai_action_reasoning": "<string>",
  "ai_time_precision": "<string>",
  "ai_followup_strategy": "<string>",
  "ai_action_rationale": "<string>",
  "ai_draft_subject": "<string>",
  "ai_draft_message": "<string>",
  "ai_draft_metadata": "<string>",
  "id_lead": "<string>",
  "id_space": "<string>"
}
{
"code": "BAD_REQUEST",
"message": "Invalid input data",
"issues": []
}
{
"code": "UNAUTHORIZED",
"message": "Authorization not provided",
"issues": []
}
{
"code": "FORBIDDEN",
"message": "Insufficient access",
"issues": []
}
{
"code": "NOT_FOUND",
"message": "Not found",
"issues": []
}
{
"code": "INTERNAL_SERVER_ERROR",
"message": "Internal server error",
"issues": []
}

Authorizations

X-API-KEY
string
header
required

Path Parameters

id
string
required

Body

application/json
id_lead
string
name
string
Required string length: 1 - 255
date
string<date-time>
cron
is_done
boolean
users
string[]

Response

Successful response

id
string<uuid>
required
date
string | null
required
name
string | null
required
cron
string | null
required
cron_id
string | null
required
created_at
string
required
updated_at
string | null
required
is_deleted
boolean
required
is_done
boolean
required
ai_generated
boolean | null
required
ai_action_channel
string | null
required
ai_action_description
string | null
required
ai_action_priority
string | null
required
ai_action_reasoning
string | null
required
ai_time_precision
string | null
required
ai_followup_strategy
string | null
required
ai_action_rationale
string | null
required
ai_draft_subject
string | null
required
ai_draft_message
string | null
required
ai_draft_metadata
string | null
required
id_lead
string | null
required
id_space
string | null
required