Notities

Notities van een klant opvragen

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

De notities bij een klant, nieuwste eerst.

Scope: customers.read — Klanten en leads lezen

Padparameters

Naam	Type	Omschrijving
`customer` verplicht	string (uuid)	De id (UUID) van de klant.

Queryparameters

Naam	Type	Omschrijving
`limit`	integer	Aantal resultaten per pagina. van 1 tot 100 · standaard: 50
`cursor`	string	De next_cursor of prev_cursor uit meta van het vorige antwoord.

Voorbeeldverzoek

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"]

Antwoord 200

Het antwoord is een lijst met cursorpaginering: data bevat de objecten, meta de paginering.

Voorbeeldantwoord

{
  "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
  }
}

Mogelijke fouten

403 insufficient_scope — Deze API-sleutel heeft geen toegang tot deze actie.
404 not_found — Niet gevonden.
422 validation_failed — De invoer is ongeldig.

Daarnaast kan elk endpoint de algemene fouten geven, zoals een ongeldige sleutel of een bereikte limiet. Bekijk alle foutcodes.

Notitie bij een klant plaatsen

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

Plaatst een interne notitie bij een klant. Hij staat daarna direct in Klantly. Een notitie via de API heeft geen auteur.

Scope: customers.write — Klanten en leads aanmaken en wijzigen

Stuur een Idempotency-Key mee, dan maakt een nieuwe poging na een time-out geen dubbel record.

Padparameters

Naam	Type	Omschrijving
`customer` verplicht	string (uuid)	De id (UUID) van de klant.

Body (JSON)

Veld	Type	Omschrijving
`content` verplicht	string	De tekst van de notitie. maximaal 10000 tekens
`is_important` optioneel	boolean	Gemarkeerd als belangrijk.

Voorbeeldverzoek

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"]

Antwoord 201

Voorbeeldantwoord

{
  "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"
  }
}

Mogelijke fouten

403 insufficient_scope — Deze API-sleutel heeft geen toegang tot deze actie.
422 validation_failed — De invoer is ongeldig.
422 unknown_field — De invoer bevat een onbekend veld.
415 unsupported_media_type — Dit formaat wordt niet ondersteund.
413 payload_too_large — De body van het verzoek is te groot.
404 not_found — Niet gevonden.
422 idempotency_key_reused — Deze Idempotency-Key is al gebruikt voor een ander verzoek.
409 idempotency_in_progress — Een verzoek met deze Idempotency-Key is nog bezig.

Daarnaast kan elk endpoint de algemene fouten geven, zoals een ongeldige sleutel of een bereikte limiet. Bekijk alle foutcodes.

Notitie bij een klant wijzigen

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

Wijzigt alleen de velden die je meestuurt.

Scope: customers.write — Klanten en leads aanmaken en wijzigen

Padparameters

Naam	Type	Omschrijving
`customer` verplicht	string (uuid)	De id (UUID) van de klant.
`note` verplicht	string (uuid)	De id (UUID) van de notitie.

Body (JSON)

Veld	Type	Omschrijving
`content` optioneel	string	De tekst van de notitie. maximaal 10000 tekens
`is_important` optioneel	boolean	Gemarkeerd als belangrijk.

Voorbeeldverzoek

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"]

Antwoord 200

Voorbeeldantwoord

{
  "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"
  }
}

Mogelijke fouten

403 insufficient_scope — Deze API-sleutel heeft geen toegang tot deze actie.
422 validation_failed — De invoer is ongeldig.
422 unknown_field — De invoer bevat een onbekend veld.
415 unsupported_media_type — Dit formaat wordt niet ondersteund.
413 payload_too_large — De body van het verzoek is te groot.
404 not_found — Niet gevonden.

Daarnaast kan elk endpoint de algemene fouten geven, zoals een ongeldige sleutel of een bereikte limiet. Bekijk alle foutcodes.

Notitie bij een klant verwijderen

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

Verwijdert de notitie en de bijlagen ervan. Dit kan niet ongedaan worden gemaakt.

Scope: customers.write — Klanten en leads aanmaken en wijzigen

Padparameters

Naam	Type	Omschrijving
`customer` verplicht	string (uuid)	De id (UUID) van de klant.
`note` verplicht	string (uuid)	De id (UUID) van de notitie.

Voorbeeldverzoek

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"]

Antwoord 200

Voorbeeldantwoord

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

Mogelijke fouten

403 insufficient_scope — Deze API-sleutel heeft geen toegang tot deze actie.
404 not_found — Niet gevonden.

Daarnaast kan elk endpoint de algemene fouten geven, zoals een ongeldige sleutel of een bereikte limiet. Bekijk alle foutcodes.

Notities van een deal opvragen

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

De notities bij een deal, nieuwste eerst.

Scope: deals.read — Deals en pipelinefasen lezen
Vereiste functie: pipeline

Padparameters

Naam	Type	Omschrijving
`deal` verplicht	string (uuid)	De id (UUID) van de deal.

Queryparameters

Naam	Type	Omschrijving
`limit`	integer	Aantal resultaten per pagina. van 1 tot 100 · standaard: 50
`cursor`	string	De next_cursor of prev_cursor uit meta van het vorige antwoord.

Voorbeeldverzoek

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"]

Antwoord 200

Het antwoord is een lijst met cursorpaginering: data bevat de objecten, meta de paginering.

Voorbeeldantwoord

{
  "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
  }
}

Mogelijke fouten

403 insufficient_scope — Deze API-sleutel heeft geen toegang tot deze actie.
404 not_found — Niet gevonden.
422 validation_failed — De invoer is ongeldig.

Daarnaast kan elk endpoint de algemene fouten geven, zoals een ongeldige sleutel of een bereikte limiet. Bekijk alle foutcodes.

Notitie bij een deal plaatsen

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

Plaatst een interne notitie bij een deal. Hij staat daarna direct in Klantly. Een notitie via de API heeft geen auteur.

Scope: deals.write — Deals aanmaken, wijzigen, verplaatsen en archiveren
Vereiste functie: pipeline

Stuur een Idempotency-Key mee, dan maakt een nieuwe poging na een time-out geen dubbel record.

Padparameters

Naam	Type	Omschrijving
`deal` verplicht	string (uuid)	De id (UUID) van de deal.

Body (JSON)

Veld	Type	Omschrijving
`content` verplicht	string	De tekst van de notitie. maximaal 10000 tekens
`is_important` optioneel	boolean	Gemarkeerd als belangrijk.

Voorbeeldverzoek

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"]

Antwoord 201

Voorbeeldantwoord

{
  "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"
  }
}

Mogelijke fouten

403 insufficient_scope — Deze API-sleutel heeft geen toegang tot deze actie.
422 validation_failed — De invoer is ongeldig.
422 unknown_field — De invoer bevat een onbekend veld.
415 unsupported_media_type — Dit formaat wordt niet ondersteund.
413 payload_too_large — De body van het verzoek is te groot.
404 not_found — Niet gevonden.
422 idempotency_key_reused — Deze Idempotency-Key is al gebruikt voor een ander verzoek.
409 idempotency_in_progress — Een verzoek met deze Idempotency-Key is nog bezig.

Daarnaast kan elk endpoint de algemene fouten geven, zoals een ongeldige sleutel of een bereikte limiet. Bekijk alle foutcodes.

Notitie bij een deal wijzigen

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

Wijzigt alleen de velden die je meestuurt.

Scope: deals.write — Deals aanmaken, wijzigen, verplaatsen en archiveren
Vereiste functie: pipeline

Padparameters

Naam	Type	Omschrijving
`deal` verplicht	string (uuid)	De id (UUID) van de deal.
`note` verplicht	string (uuid)	De id (UUID) van de notitie.

Body (JSON)

Veld	Type	Omschrijving
`content` optioneel	string	De tekst van de notitie. maximaal 10000 tekens
`is_important` optioneel	boolean	Gemarkeerd als belangrijk.

Voorbeeldverzoek

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"]

Antwoord 200

Voorbeeldantwoord

{
  "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"
  }
}

Mogelijke fouten

403 insufficient_scope — Deze API-sleutel heeft geen toegang tot deze actie.
422 validation_failed — De invoer is ongeldig.
422 unknown_field — De invoer bevat een onbekend veld.
415 unsupported_media_type — Dit formaat wordt niet ondersteund.
413 payload_too_large — De body van het verzoek is te groot.
404 not_found — Niet gevonden.

Daarnaast kan elk endpoint de algemene fouten geven, zoals een ongeldige sleutel of een bereikte limiet. Bekijk alle foutcodes.

Notitie bij een deal verwijderen

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

Verwijdert de notitie en de bijlagen ervan. Dit kan niet ongedaan worden gemaakt.

Scope: deals.write — Deals aanmaken, wijzigen, verplaatsen en archiveren
Vereiste functie: pipeline

Padparameters

Naam	Type	Omschrijving
`deal` verplicht	string (uuid)	De id (UUID) van de deal.
`note` verplicht	string (uuid)	De id (UUID) van de notitie.

Voorbeeldverzoek

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"]

Antwoord 200

Voorbeeldantwoord

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

Mogelijke fouten

403 insufficient_scope — Deze API-sleutel heeft geen toegang tot deze actie.
404 not_found — Niet gevonden.

Daarnaast kan elk endpoint de algemene fouten geven, zoals een ongeldige sleutel of een bereikte limiet. Bekijk alle foutcodes.

Het object

Alle velden zijn altijd aanwezig; een veld zonder waarde is null.

Veld	Type	Omschrijving
`object`	string	Altijd "note".
`id`	string (uuid)	Unieke id (UUID).
`content`	string	De tekst van de notitie.
`is_important`	boolean	Gemarkeerd als belangrijk.
`parent`	object	Waar de notitie bij hoort.
`parent.object`	string	"customer" of "deal". een van: customer, deal
`parent.id`	string (uuid)	Id van de klant of deal.
`author`	object	Wie de notitie schreef, of null bij een notitie via de API. kan leeg zijn (null)
`author.object`	string	Altijd "user".
`author.id`	string	Id van de gebruiker.
`author.name`	string	Naam van de gebruiker.
`created_at`	string (date-time)	Aangemaakt op (UTC).
`updated_at`	string (date-time)	Laatst gewijzigd op (UTC).

Endpoints

Notities van een klant opvragen#

Padparameters

Queryparameters

Voorbeeldverzoek

Antwoord 200

Mogelijke fouten

Notitie bij een klant plaatsen#

Padparameters

Body (JSON)

Voorbeeldverzoek

Antwoord 201

Mogelijke fouten

Notitie bij een klant wijzigen#

Padparameters

Body (JSON)

Voorbeeldverzoek

Antwoord 200

Mogelijke fouten

Notitie bij een klant verwijderen#

Padparameters

Voorbeeldverzoek

Antwoord 200

Mogelijke fouten

Notities van een deal opvragen#

Padparameters

Queryparameters

Voorbeeldverzoek

Antwoord 200

Mogelijke fouten

Notitie bij een deal plaatsen#

Padparameters

Body (JSON)

Voorbeeldverzoek

Antwoord 201

Mogelijke fouten

Notitie bij een deal wijzigen#

Padparameters

Body (JSON)

Voorbeeldverzoek

Antwoord 200

Mogelijke fouten

Notitie bij een deal verwijderen#

Padparameters

Voorbeeldverzoek

Antwoord 200

Mogelijke fouten

Het object#

Notities van een klant opvragen

Notitie bij een klant plaatsen

Notitie bij een klant wijzigen

Notitie bij een klant verwijderen

Notities van een deal opvragen

Notitie bij een deal plaatsen

Notitie bij een deal wijzigen

Notitie bij een deal verwijderen

Het object