Smazání kontaktu

DELETE

/api/v2/admin/contacts/{id}

Kontakt se neodstraní úplně, jen se označí jako smazaný a přestane se vracet ve výpisech i v seznamu kontaktů. Operaci nelze přes API vrátit zpět. Opakované volání na stejné ID vrací 404.

Autentizace a oprávnění

Vyžaduje API token: Bearer v hlavičce nebo URL token.

Parametry

Parametry cesty

Název	Typ	Povinný	Popis	Příklad
`id`	integer	ano	ID kontaktu vaší firmy.	`21`

Příklad požadavku

curl

curl -X DELETE 'https://www.elpokladny.cz/api/v2/admin/contacts/21' \
  -H 'Authorization: Bearer elp_live_example.example_secret'

PHP

<?php
$ch = curl_init('https://www.elpokladny.cz/api/v2/admin/contacts/21');
curl_setopt_array($ch, [
    CURLOPT_CUSTOMREQUEST => 'DELETE',
    CURLOPT_RETURNTRANSFER => true,
    CURLOPT_HTTPHEADER => array (
  0 => 'Authorization: Bearer elp_live_example.example_secret',
),
]);
$response = curl_exec($ch);
curl_close($ch);
echo $response;

javascript

const response = await fetch("https://www.elpokladny.cz/api/v2/admin/contacts/21", {
    "method": "DELETE",
    "headers": {
        "Authorization": "Bearer elp_live_example.example_secret"
    }
});
const data = await response.json();

Ukázkové odpovědi

Kontakt smazán (HTTP 200)

application/json

{
  "status": "success"
}

Kontakt neexistuje (HTTP 404)

application/json

{
  "status": "error",
  "message": "Kontakt nebyl nalezen."
}

Možné chyby

Chybové stavy

HTTP	Kdy	Podoba
401	Chybí nebo je neplatný API token.	status-message
403	API token se použil z IP adresy, která není u přístupu povolená.	status-message
404	Kontakt s tímto ID neexistuje, je už smazaný, nebo patří jiné firmě.	status-message

Související návody

Adresář