Notes

Lister les notes d'un client

GET /api/v1/customers/{customer}/notes

Les notes d'un client, les plus récentes en premier.

Scope: customers.read — Lire les clients et les prospects

Paramètres de chemin

Nom	Type	Description
`customer` obligatoire	string (uuid)	L'id (UUID) du client.

Paramètres de requête

Nom	Type	Description
`limit`	integer	Nombre de résultats par page. de 1 à 100 · par défaut : 50
`cursor`	string	Le next_cursor ou prev_cursor de meta dans la réponse précédente.

Exemple de requête

cURL

curl "https://app.klantly.com/api/v1/customers/9d3f6c1e-4b2a-4c8e-9f1a-2b3c4d5e6f70/notes" \
  -H "Authorization: Bearer $KLANTLY_API_KEY"

PHP

$client = new \GuzzleHttp\Client([
    'base_uri' => 'https://app.klantly.com/api/v1/',
    'headers' => ['Authorization' => 'Bearer ' . getenv('KLANTLY_API_KEY')],
]);

$response = $client->request('GET', 'customers/9d3f6c1e-4b2a-4c8e-9f1a-2b3c4d5e6f70/notes');

$data = json_decode((string) $response->getBody(), true)['data'];

JavaScript

const response = await fetch('https://app.klantly.com/api/v1/customers/9d3f6c1e-4b2a-4c8e-9f1a-2b3c4d5e6f70/notes', {
  headers: {
    Authorization: `Bearer ${process.env.KLANTLY_API_KEY}`,
  },
});

const { data } = await response.json();

Python

import os

import requests

response = requests.get(
    "https://app.klantly.com/api/v1/customers/9d3f6c1e-4b2a-4c8e-9f1a-2b3c4d5e6f70/notes",
    headers={
        "Authorization": f"Bearer {os.environ['KLANTLY_API_KEY']}",
    },
)
data = response.json()["data"]

Réponse 200

La réponse est une liste avec pagination par curseur : data contient les objets, meta la pagination.

Exemple de réponse

{
  "data": [
    {
      "object": "note",
      "id": "9d3f7b41-2d6f-4e8c-9b3a-4f5d6e7a8b92",
      "content": "Klant belt terug na de vakantie.",
      "is_important": true,
      "parent": {
        "object": "customer",
        "id": "9d3f6c1e-4b2a-4c8e-9f1a-2b3c4d5e6f70"
      },
      "author": {
        "object": "user",
        "id": "7",
        "name": "Sanne Bakker"
      },
      "created_at": "2026-09-14T10:15:00Z",
      "updated_at": "2026-09-14T10:15:00Z"
    }
  ],
  "meta": {
    "limit": 50,
    "next_cursor": "eyJpZCI6IjlkM2Y2YzFlIn0",
    "prev_cursor": null
  }
}

Erreurs possibles

403 insufficient_scope — Cette clé API n'a pas accès à cette action.
404 not_found — Introuvable.
422 validation_failed — Les données saisies ne sont pas valides.

En outre, chaque endpoint peut renvoyer les erreurs générales, comme une clé invalide ou une limite atteinte. Voir tous les codes d'erreur.

Ajouter une note à un client

POST /api/v1/customers/{customer}/notes

Ajoute une note interne à un client. Elle apparaît immédiatement dans Klantly. Une note ajoutée via l'API n'a pas d'auteur.

Scope: customers.write — Créer et modifier les clients et les prospects

Envoyez une Idempotency-Key : une nouvelle tentative après un délai d'attente ne crée alors jamais de doublon.

Paramètres de chemin

Nom	Type	Description
`customer` obligatoire	string (uuid)	L'id (UUID) du client.

Corps (JSON)

Champ	Type	Description
`content` obligatoire	string	Le texte de la note. au maximum 10000 caractères
`is_important` facultatif	boolean	Marquée comme importante.

Exemple de requête

cURL

curl -X POST "https://app.klantly.com/api/v1/customers/9d3f6c1e-4b2a-4c8e-9f1a-2b3c4d5e6f70/notes" \
  -H "Authorization: Bearer $KLANTLY_API_KEY" \
  -H "Content-Type: application/json" \
  -H "Idempotency-Key: 6f1c2d3e-4a5b-4c6d-8e7f-9a0b1c2d3e4f" \
  -d '{
  "content": "Klant belt terug na de vakantie.",
  "is_important": true
}'

PHP

$client = new \GuzzleHttp\Client([
    'base_uri' => 'https://app.klantly.com/api/v1/',
    'headers' => ['Authorization' => 'Bearer ' . getenv('KLANTLY_API_KEY')],
]);

$response = $client->request('POST', 'customers/9d3f6c1e-4b2a-4c8e-9f1a-2b3c4d5e6f70/notes', [
    'headers' => [
        'Idempotency-Key' => '6f1c2d3e-4a5b-4c6d-8e7f-9a0b1c2d3e4f',
    ],
    'json' => [
        'content' => 'Klant belt terug na de vakantie.',
        'is_important' => true,
    ],
]);

$data = json_decode((string) $response->getBody(), true)['data'];

JavaScript

const response = await fetch('https://app.klantly.com/api/v1/customers/9d3f6c1e-4b2a-4c8e-9f1a-2b3c4d5e6f70/notes', {
  method: 'POST',
  headers: {
    Authorization: `Bearer ${process.env.KLANTLY_API_KEY}`,
    'Content-Type': 'application/json',
    'Idempotency-Key': '6f1c2d3e-4a5b-4c6d-8e7f-9a0b1c2d3e4f',
  },
  body: JSON.stringify({
  "content": "Klant belt terug na de vakantie.",
  "is_important": true
}),
});

const { data } = await response.json();

Python

import os

import requests

response = requests.post(
    "https://app.klantly.com/api/v1/customers/9d3f6c1e-4b2a-4c8e-9f1a-2b3c4d5e6f70/notes",
    headers={
        "Authorization": f"Bearer {os.environ['KLANTLY_API_KEY']}",
        "Idempotency-Key": "6f1c2d3e-4a5b-4c6d-8e7f-9a0b1c2d3e4f",
    },
    json={
        "content": "Klant belt terug na de vakantie.",
        "is_important": True
    },
)
data = response.json()["data"]

Réponse 201

Exemple de réponse

{
  "data": {
    "object": "note",
    "id": "9d3f7b41-2d6f-4e8c-9b3a-4f5d6e7a8b92",
    "content": "Klant belt terug na de vakantie.",
    "is_important": true,
    "parent": {
      "object": "customer",
      "id": "9d3f6c1e-4b2a-4c8e-9f1a-2b3c4d5e6f70"
    },
    "author": {
      "object": "user",
      "id": "7",
      "name": "Sanne Bakker"
    },
    "created_at": "2026-09-14T10:15:00Z",
    "updated_at": "2026-09-14T10:15:00Z"
  }
}

Erreurs possibles

403 insufficient_scope — Cette clé API n'a pas accès à cette action.
422 validation_failed — Les données saisies ne sont pas valides.
422 unknown_field — Les données contiennent un champ inconnu.
415 unsupported_media_type — Ce format n'est pas pris en charge.
413 payload_too_large — Le corps de la requête est trop volumineux.
404 not_found — Introuvable.
422 idempotency_key_reused — Cette Idempotency-Key a déjà été utilisée pour une autre requête.
409 idempotency_in_progress — Une requête avec cette Idempotency-Key est encore en cours.

En outre, chaque endpoint peut renvoyer les erreurs générales, comme une clé invalide ou une limite atteinte. Voir tous les codes d'erreur.

Modifier une note d'un client

PATCH /api/v1/customers/{customer}/notes/{note}

Modifie uniquement les champs que vous envoyez.

Scope: customers.write — Créer et modifier les clients et les prospects

Paramètres de chemin

Nom	Type	Description
`customer` obligatoire	string (uuid)	L'id (UUID) du client.
`note` obligatoire	string (uuid)	L'id (UUID) de la note.

Corps (JSON)

Champ	Type	Description
`content` facultatif	string	Le texte de la note. au maximum 10000 caractères
`is_important` facultatif	boolean	Marquée comme importante.

Exemple de requête

cURL

curl -X PATCH "https://app.klantly.com/api/v1/customers/9d3f6c1e-4b2a-4c8e-9f1a-2b3c4d5e6f70/notes/9d3f6c1e-4b2a-4c8e-9f1a-2b3c4d5e6f70" \
  -H "Authorization: Bearer $KLANTLY_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{
  "is_important": false
}'

PHP

$client = new \GuzzleHttp\Client([
    'base_uri' => 'https://app.klantly.com/api/v1/',
    'headers' => ['Authorization' => 'Bearer ' . getenv('KLANTLY_API_KEY')],
]);

$response = $client->request('PATCH', 'customers/9d3f6c1e-4b2a-4c8e-9f1a-2b3c4d5e6f70/notes/9d3f6c1e-4b2a-4c8e-9f1a-2b3c4d5e6f70', [
    'json' => [
        'is_important' => false,
    ],
]);

$data = json_decode((string) $response->getBody(), true)['data'];

JavaScript

const response = await fetch('https://app.klantly.com/api/v1/customers/9d3f6c1e-4b2a-4c8e-9f1a-2b3c4d5e6f70/notes/9d3f6c1e-4b2a-4c8e-9f1a-2b3c4d5e6f70', {
  method: 'PATCH',
  headers: {
    Authorization: `Bearer ${process.env.KLANTLY_API_KEY}`,
    'Content-Type': 'application/json',
  },
  body: JSON.stringify({
  "is_important": false
}),
});

const { data } = await response.json();

Python

import os

import requests

response = requests.patch(
    "https://app.klantly.com/api/v1/customers/9d3f6c1e-4b2a-4c8e-9f1a-2b3c4d5e6f70/notes/9d3f6c1e-4b2a-4c8e-9f1a-2b3c4d5e6f70",
    headers={
        "Authorization": f"Bearer {os.environ['KLANTLY_API_KEY']}",
    },
    json={
        "is_important": False
    },
)
data = response.json()["data"]

Réponse 200

Exemple de réponse

{
  "data": {
    "object": "note",
    "id": "9d3f7b41-2d6f-4e8c-9b3a-4f5d6e7a8b92",
    "content": "Klant belt terug na de vakantie.",
    "is_important": true,
    "parent": {
      "object": "customer",
      "id": "9d3f6c1e-4b2a-4c8e-9f1a-2b3c4d5e6f70"
    },
    "author": {
      "object": "user",
      "id": "7",
      "name": "Sanne Bakker"
    },
    "created_at": "2026-09-14T10:15:00Z",
    "updated_at": "2026-09-14T10:15:00Z"
  }
}

Erreurs possibles

403 insufficient_scope — Cette clé API n'a pas accès à cette action.
422 validation_failed — Les données saisies ne sont pas valides.
422 unknown_field — Les données contiennent un champ inconnu.
415 unsupported_media_type — Ce format n'est pas pris en charge.
413 payload_too_large — Le corps de la requête est trop volumineux.
404 not_found — Introuvable.

En outre, chaque endpoint peut renvoyer les erreurs générales, comme une clé invalide ou une limite atteinte. Voir tous les codes d'erreur.

Supprimer une note d'un client

DELETE /api/v1/customers/{customer}/notes/{note}

Supprime la note et ses pièces jointes. Cette action est irréversible.

Scope: customers.write — Créer et modifier les clients et les prospects

Paramètres de chemin

Nom	Type	Description
`customer` obligatoire	string (uuid)	L'id (UUID) du client.
`note` obligatoire	string (uuid)	L'id (UUID) de la note.

Exemple de requête

cURL

curl -X DELETE "https://app.klantly.com/api/v1/customers/9d3f6c1e-4b2a-4c8e-9f1a-2b3c4d5e6f70/notes/9d3f6c1e-4b2a-4c8e-9f1a-2b3c4d5e6f70" \
  -H "Authorization: Bearer $KLANTLY_API_KEY"

PHP

$client = new \GuzzleHttp\Client([
    'base_uri' => 'https://app.klantly.com/api/v1/',
    'headers' => ['Authorization' => 'Bearer ' . getenv('KLANTLY_API_KEY')],
]);

$response = $client->request('DELETE', 'customers/9d3f6c1e-4b2a-4c8e-9f1a-2b3c4d5e6f70/notes/9d3f6c1e-4b2a-4c8e-9f1a-2b3c4d5e6f70');

$data = json_decode((string) $response->getBody(), true)['data'];

JavaScript

const response = await fetch('https://app.klantly.com/api/v1/customers/9d3f6c1e-4b2a-4c8e-9f1a-2b3c4d5e6f70/notes/9d3f6c1e-4b2a-4c8e-9f1a-2b3c4d5e6f70', {
  method: 'DELETE',
  headers: {
    Authorization: `Bearer ${process.env.KLANTLY_API_KEY}`,
  },
});

const { data } = await response.json();

Python

import os

import requests

response = requests.delete(
    "https://app.klantly.com/api/v1/customers/9d3f6c1e-4b2a-4c8e-9f1a-2b3c4d5e6f70/notes/9d3f6c1e-4b2a-4c8e-9f1a-2b3c4d5e6f70",
    headers={
        "Authorization": f"Bearer {os.environ['KLANTLY_API_KEY']}",
    },
)
data = response.json()["data"]

Réponse 200

Exemple de réponse

{
  "data": {
    "object": "note",
    "id": "9d3f7b41-2d6f-4e8c-9b3a-4f5d6e7a8b92",
    "deleted": true
  }
}

Erreurs possibles

403 insufficient_scope — Cette clé API n'a pas accès à cette action.
404 not_found — Introuvable.

En outre, chaque endpoint peut renvoyer les erreurs générales, comme une clé invalide ou une limite atteinte. Voir tous les codes d'erreur.

Lister les notes d'un deal

GET /api/v1/deals/{deal}/notes

Les notes d'un deal, les plus récentes en premier.

Scope: deals.read — Lire les affaires et les étapes du pipeline
Fonctionnalité requise: pipeline

Paramètres de chemin

Nom	Type	Description
`deal` obligatoire	string (uuid)	L'id (UUID) du deal.

Paramètres de requête

Nom	Type	Description
`limit`	integer	Nombre de résultats par page. de 1 à 100 · par défaut : 50
`cursor`	string	Le next_cursor ou prev_cursor de meta dans la réponse précédente.

Exemple de requête

cURL

curl "https://app.klantly.com/api/v1/deals/9d3f6c1e-4b2a-4c8e-9f1a-2b3c4d5e6f70/notes" \
  -H "Authorization: Bearer $KLANTLY_API_KEY"

PHP

$client = new \GuzzleHttp\Client([
    'base_uri' => 'https://app.klantly.com/api/v1/',
    'headers' => ['Authorization' => 'Bearer ' . getenv('KLANTLY_API_KEY')],
]);

$response = $client->request('GET', 'deals/9d3f6c1e-4b2a-4c8e-9f1a-2b3c4d5e6f70/notes');

$data = json_decode((string) $response->getBody(), true)['data'];

JavaScript

const response = await fetch('https://app.klantly.com/api/v1/deals/9d3f6c1e-4b2a-4c8e-9f1a-2b3c4d5e6f70/notes', {
  headers: {
    Authorization: `Bearer ${process.env.KLANTLY_API_KEY}`,
  },
});

const { data } = await response.json();

Python

import os

import requests

response = requests.get(
    "https://app.klantly.com/api/v1/deals/9d3f6c1e-4b2a-4c8e-9f1a-2b3c4d5e6f70/notes",
    headers={
        "Authorization": f"Bearer {os.environ['KLANTLY_API_KEY']}",
    },
)
data = response.json()["data"]

Réponse 200

La réponse est une liste avec pagination par curseur : data contient les objets, meta la pagination.

Exemple de réponse

{
  "data": [
    {
      "object": "note",
      "id": "9d3f7b41-2d6f-4e8c-9b3a-4f5d6e7a8b92",
      "content": "Klant belt terug na de vakantie.",
      "is_important": true,
      "parent": {
        "object": "customer",
        "id": "9d3f6c1e-4b2a-4c8e-9f1a-2b3c4d5e6f70"
      },
      "author": {
        "object": "user",
        "id": "7",
        "name": "Sanne Bakker"
      },
      "created_at": "2026-09-14T10:15:00Z",
      "updated_at": "2026-09-14T10:15:00Z"
    }
  ],
  "meta": {
    "limit": 50,
    "next_cursor": "eyJpZCI6IjlkM2Y2YzFlIn0",
    "prev_cursor": null
  }
}

Erreurs possibles

403 insufficient_scope — Cette clé API n'a pas accès à cette action.
404 not_found — Introuvable.
422 validation_failed — Les données saisies ne sont pas valides.

En outre, chaque endpoint peut renvoyer les erreurs générales, comme une clé invalide ou une limite atteinte. Voir tous les codes d'erreur.

Ajouter une note à un deal

POST /api/v1/deals/{deal}/notes

Ajoute une note interne à un deal. Elle apparaît immédiatement dans Klantly. Une note ajoutée via l'API n'a pas d'auteur.

Scope: deals.write — Créer, modifier, déplacer et archiver les affaires
Fonctionnalité requise: pipeline

Envoyez une Idempotency-Key : une nouvelle tentative après un délai d'attente ne crée alors jamais de doublon.

Paramètres de chemin

Nom	Type	Description
`deal` obligatoire	string (uuid)	L'id (UUID) du deal.

Corps (JSON)

Champ	Type	Description
`content` obligatoire	string	Le texte de la note. au maximum 10000 caractères
`is_important` facultatif	boolean	Marquée comme importante.

Exemple de requête

cURL

curl -X POST "https://app.klantly.com/api/v1/deals/9d3f6c1e-4b2a-4c8e-9f1a-2b3c4d5e6f70/notes" \
  -H "Authorization: Bearer $KLANTLY_API_KEY" \
  -H "Content-Type: application/json" \
  -H "Idempotency-Key: 6f1c2d3e-4a5b-4c6d-8e7f-9a0b1c2d3e4f" \
  -d '{
  "content": "Klant belt terug na de vakantie.",
  "is_important": true
}'

PHP

$client = new \GuzzleHttp\Client([
    'base_uri' => 'https://app.klantly.com/api/v1/',
    'headers' => ['Authorization' => 'Bearer ' . getenv('KLANTLY_API_KEY')],
]);

$response = $client->request('POST', 'deals/9d3f6c1e-4b2a-4c8e-9f1a-2b3c4d5e6f70/notes', [
    'headers' => [
        'Idempotency-Key' => '6f1c2d3e-4a5b-4c6d-8e7f-9a0b1c2d3e4f',
    ],
    'json' => [
        'content' => 'Klant belt terug na de vakantie.',
        'is_important' => true,
    ],
]);

$data = json_decode((string) $response->getBody(), true)['data'];

JavaScript

const response = await fetch('https://app.klantly.com/api/v1/deals/9d3f6c1e-4b2a-4c8e-9f1a-2b3c4d5e6f70/notes', {
  method: 'POST',
  headers: {
    Authorization: `Bearer ${process.env.KLANTLY_API_KEY}`,
    'Content-Type': 'application/json',
    'Idempotency-Key': '6f1c2d3e-4a5b-4c6d-8e7f-9a0b1c2d3e4f',
  },
  body: JSON.stringify({
  "content": "Klant belt terug na de vakantie.",
  "is_important": true
}),
});

const { data } = await response.json();

Python

import os

import requests

response = requests.post(
    "https://app.klantly.com/api/v1/deals/9d3f6c1e-4b2a-4c8e-9f1a-2b3c4d5e6f70/notes",
    headers={
        "Authorization": f"Bearer {os.environ['KLANTLY_API_KEY']}",
        "Idempotency-Key": "6f1c2d3e-4a5b-4c6d-8e7f-9a0b1c2d3e4f",
    },
    json={
        "content": "Klant belt terug na de vakantie.",
        "is_important": True
    },
)
data = response.json()["data"]

Réponse 201

Exemple de réponse

{
  "data": {
    "object": "note",
    "id": "9d3f7b41-2d6f-4e8c-9b3a-4f5d6e7a8b92",
    "content": "Klant belt terug na de vakantie.",
    "is_important": true,
    "parent": {
      "object": "customer",
      "id": "9d3f6c1e-4b2a-4c8e-9f1a-2b3c4d5e6f70"
    },
    "author": {
      "object": "user",
      "id": "7",
      "name": "Sanne Bakker"
    },
    "created_at": "2026-09-14T10:15:00Z",
    "updated_at": "2026-09-14T10:15:00Z"
  }
}

Erreurs possibles

403 insufficient_scope — Cette clé API n'a pas accès à cette action.
422 validation_failed — Les données saisies ne sont pas valides.
422 unknown_field — Les données contiennent un champ inconnu.
415 unsupported_media_type — Ce format n'est pas pris en charge.
413 payload_too_large — Le corps de la requête est trop volumineux.
404 not_found — Introuvable.
422 idempotency_key_reused — Cette Idempotency-Key a déjà été utilisée pour une autre requête.
409 idempotency_in_progress — Une requête avec cette Idempotency-Key est encore en cours.

En outre, chaque endpoint peut renvoyer les erreurs générales, comme une clé invalide ou une limite atteinte. Voir tous les codes d'erreur.

Modifier une note d'un deal

PATCH /api/v1/deals/{deal}/notes/{note}

Modifie uniquement les champs que vous envoyez.

Scope: deals.write — Créer, modifier, déplacer et archiver les affaires
Fonctionnalité requise: pipeline

Paramètres de chemin

Nom	Type	Description
`deal` obligatoire	string (uuid)	L'id (UUID) du deal.
`note` obligatoire	string (uuid)	L'id (UUID) de la note.

Corps (JSON)

Champ	Type	Description
`content` facultatif	string	Le texte de la note. au maximum 10000 caractères
`is_important` facultatif	boolean	Marquée comme importante.

Exemple de requête

cURL

curl -X PATCH "https://app.klantly.com/api/v1/deals/9d3f6c1e-4b2a-4c8e-9f1a-2b3c4d5e6f70/notes/9d3f6c1e-4b2a-4c8e-9f1a-2b3c4d5e6f70" \
  -H "Authorization: Bearer $KLANTLY_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{
  "is_important": false
}'

PHP

$client = new \GuzzleHttp\Client([
    'base_uri' => 'https://app.klantly.com/api/v1/',
    'headers' => ['Authorization' => 'Bearer ' . getenv('KLANTLY_API_KEY')],
]);

$response = $client->request('PATCH', 'deals/9d3f6c1e-4b2a-4c8e-9f1a-2b3c4d5e6f70/notes/9d3f6c1e-4b2a-4c8e-9f1a-2b3c4d5e6f70', [
    'json' => [
        'is_important' => false,
    ],
]);

$data = json_decode((string) $response->getBody(), true)['data'];

JavaScript

const response = await fetch('https://app.klantly.com/api/v1/deals/9d3f6c1e-4b2a-4c8e-9f1a-2b3c4d5e6f70/notes/9d3f6c1e-4b2a-4c8e-9f1a-2b3c4d5e6f70', {
  method: 'PATCH',
  headers: {
    Authorization: `Bearer ${process.env.KLANTLY_API_KEY}`,
    'Content-Type': 'application/json',
  },
  body: JSON.stringify({
  "is_important": false
}),
});

const { data } = await response.json();

Python

import os

import requests

response = requests.patch(
    "https://app.klantly.com/api/v1/deals/9d3f6c1e-4b2a-4c8e-9f1a-2b3c4d5e6f70/notes/9d3f6c1e-4b2a-4c8e-9f1a-2b3c4d5e6f70",
    headers={
        "Authorization": f"Bearer {os.environ['KLANTLY_API_KEY']}",
    },
    json={
        "is_important": False
    },
)
data = response.json()["data"]

Réponse 200

Exemple de réponse

{
  "data": {
    "object": "note",
    "id": "9d3f7b41-2d6f-4e8c-9b3a-4f5d6e7a8b92",
    "content": "Klant belt terug na de vakantie.",
    "is_important": true,
    "parent": {
      "object": "customer",
      "id": "9d3f6c1e-4b2a-4c8e-9f1a-2b3c4d5e6f70"
    },
    "author": {
      "object": "user",
      "id": "7",
      "name": "Sanne Bakker"
    },
    "created_at": "2026-09-14T10:15:00Z",
    "updated_at": "2026-09-14T10:15:00Z"
  }
}

Erreurs possibles

403 insufficient_scope — Cette clé API n'a pas accès à cette action.
422 validation_failed — Les données saisies ne sont pas valides.
422 unknown_field — Les données contiennent un champ inconnu.
415 unsupported_media_type — Ce format n'est pas pris en charge.
413 payload_too_large — Le corps de la requête est trop volumineux.
404 not_found — Introuvable.

En outre, chaque endpoint peut renvoyer les erreurs générales, comme une clé invalide ou une limite atteinte. Voir tous les codes d'erreur.

Supprimer une note d'un deal

DELETE /api/v1/deals/{deal}/notes/{note}

Supprime la note et ses pièces jointes. Cette action est irréversible.

Scope: deals.write — Créer, modifier, déplacer et archiver les affaires
Fonctionnalité requise: pipeline

Paramètres de chemin

Nom	Type	Description
`deal` obligatoire	string (uuid)	L'id (UUID) du deal.
`note` obligatoire	string (uuid)	L'id (UUID) de la note.

Exemple de requête

cURL

curl -X DELETE "https://app.klantly.com/api/v1/deals/9d3f6c1e-4b2a-4c8e-9f1a-2b3c4d5e6f70/notes/9d3f6c1e-4b2a-4c8e-9f1a-2b3c4d5e6f70" \
  -H "Authorization: Bearer $KLANTLY_API_KEY"

PHP

$client = new \GuzzleHttp\Client([
    'base_uri' => 'https://app.klantly.com/api/v1/',
    'headers' => ['Authorization' => 'Bearer ' . getenv('KLANTLY_API_KEY')],
]);

$response = $client->request('DELETE', 'deals/9d3f6c1e-4b2a-4c8e-9f1a-2b3c4d5e6f70/notes/9d3f6c1e-4b2a-4c8e-9f1a-2b3c4d5e6f70');

$data = json_decode((string) $response->getBody(), true)['data'];

JavaScript

const response = await fetch('https://app.klantly.com/api/v1/deals/9d3f6c1e-4b2a-4c8e-9f1a-2b3c4d5e6f70/notes/9d3f6c1e-4b2a-4c8e-9f1a-2b3c4d5e6f70', {
  method: 'DELETE',
  headers: {
    Authorization: `Bearer ${process.env.KLANTLY_API_KEY}`,
  },
});

const { data } = await response.json();

Python

import os

import requests

response = requests.delete(
    "https://app.klantly.com/api/v1/deals/9d3f6c1e-4b2a-4c8e-9f1a-2b3c4d5e6f70/notes/9d3f6c1e-4b2a-4c8e-9f1a-2b3c4d5e6f70",
    headers={
        "Authorization": f"Bearer {os.environ['KLANTLY_API_KEY']}",
    },
)
data = response.json()["data"]

Réponse 200

Exemple de réponse

{
  "data": {
    "object": "note",
    "id": "9d3f7b41-2d6f-4e8c-9b3a-4f5d6e7a8b92",
    "deleted": true
  }
}

Erreurs possibles

403 insufficient_scope — Cette clé API n'a pas accès à cette action.
404 not_found — Introuvable.

En outre, chaque endpoint peut renvoyer les erreurs générales, comme une clé invalide ou une limite atteinte. Voir tous les codes d'erreur.

L'objet

Tous les champs sont toujours présents ; un champ sans valeur vaut null.

Champ	Type	Description
`object`	string	Toujours « note ».
`id`	string (uuid)	Id unique (UUID).
`content`	string	Le texte de la note.
`is_important`	boolean	Marquée comme importante.
`parent`	object	Ce à quoi la note appartient.
`parent.object`	string	« customer » ou « deal ». l'une des valeurs : customer, deal
`parent.id`	string (uuid)	Id du client ou du deal.
`author`	object	Qui a écrit la note, ou null pour une note ajoutée via l'API. peut être vide (null)
`author.object`	string	Toujours « user ».
`author.id`	string	Id de l'utilisateur.
`author.name`	string	Nom de l'utilisateur.
`created_at`	string (date-time)	Créé le (UTC).
`updated_at`	string (date-time)	Dernière modification le (UTC).

Endpoints

Lister les notes d'un client#

Paramètres de chemin

Paramètres de requête

Exemple de requête

Réponse 200

Erreurs possibles

Ajouter une note à un client#

Paramètres de chemin

Corps (JSON)

Exemple de requête

Réponse 201

Erreurs possibles

Modifier une note d'un client#

Paramètres de chemin

Corps (JSON)

Exemple de requête

Réponse 200

Erreurs possibles

Supprimer une note d'un client#

Paramètres de chemin

Exemple de requête

Réponse 200

Erreurs possibles

Lister les notes d'un deal#

Paramètres de chemin

Paramètres de requête

Exemple de requête

Réponse 200

Erreurs possibles

Ajouter une note à un deal#

Paramètres de chemin

Corps (JSON)

Exemple de requête

Réponse 201

Erreurs possibles

Modifier une note d'un deal#

Paramètres de chemin

Corps (JSON)

Exemple de requête

Réponse 200

Erreurs possibles

Supprimer une note d'un deal#

Paramètres de chemin

Exemple de requête

Réponse 200

Erreurs possibles

L'objet#

Lister les notes d'un client

Ajouter une note à un client

Modifier une note d'un client

Supprimer une note d'un client

Lister les notes d'un deal

Ajouter une note à un deal

Modifier une note d'un deal

Supprimer une note d'un deal

L'objet