Contact Notes API - Fi
Tämän API:n avulla voit tarkastella, muokata, luoda ja poistaa muistiinpanoja valitusta yhteystiedosta.
Lukeminen.
Hanki luettelo yhteystiedolle luoduista muistiinpanoista.
GET https://api.smartsender.com/v1/contacts/{contactId}/notes
Pääparametrit:
Nimi | Kuvaus | Validointi |
---|---|---|
page | Pyydetty sivu | Vähimmäisarvo 1 |
limitation | Näytettävien tietojen määrä sivua kohden | Pienin arvo 1, maksimi 20 |
Jos vastaus on onnistunut, saat seuraavat tiedot:
{
"cursor": Cursor,
"collection": Note[]
}
Vastauksen kuvaus:
Luominen.
Luo muistiinpano yhteystiedolle.
POST https://api.smartsender.com/v1/contacts/{contactId}/notes
Pääparametrit:
Nimi | Kuvaus |
---|---|
text | Huomautus kuvaus |
Jos vastaus on onnistunut, hanki tyyppinen objekti Note.
Päivittää.
Voit päivittää yhteystiedon valitut muistiinpanot.
PUT https://api.smartsender.com/v1/contacts/{contactId}/notes/{noteId}
Jos vastaus on onnistunut, saat seuraavat tiedot:
{
"state": true
}
Poistaminen.
Voit poistaa valitun muistiinpanon yhteystiedosta.
DELETE https://api.smartsender.com/v1/contacts/{contactId}/notes/{noteId}
Jos vastaus on onnistunut, saat seuraavat tiedot:
{
"state": true
}