Contact Notes API - lt

Naudodami šią API galite peržiūrėti, redaguoti, kurti ir ištrinti pasirinkto kontakto užrašus.

Skaitymas.

Gaukite sukurtų kontakto užrašų sąrašą.

GET https://api.smartsender.com/v1/contacts/{contactId}/notes

Pagrindiniai parametrai:

vardas	apibūdinimas	Patvirtinimas

vardas	apibūdinimas	Patvirtinimas
page	Pageidaujamas puslapis	Mažiausia vertė 1
limitation	Viename puslapyje rodomų duomenų kiekis	Mažiausia vertė 1, didžiausia 20

Sėkmingo atsakymo atveju gausite:

{
    "cursor": Cursor,
    "collection": Note[]
}

Atsakymo aprašymas:

vardas	apibūdinimas

vardas	apibūdinimas
cursor	Cursor objektas
collection	objektų masyvas Note

Kūrimas.

Sukurkite užrašą kontaktui.

POST https://api.smartsender.com/v1/contacts/{contactId}/notes

Pagrindiniai parametrai:

vardas	apibūdinimas

vardas	apibūdinimas
text	Pastabos aprašymas

Sėkmingo atsakymo atveju gaukite tipo objektą Note

Atnaujinti.

Leidžia atnaujinti pasirinktas kontakto pastabas.

PUT https://api.smartsender.com/v1/contacts/{contactId}/notes/{noteId}

Sėkmingo atsakymo atveju gausite:

{
    "state": true
}

Pašalinimas.

Leidžia ištrinti pasirinktą užrašą iš adresato.

DELETE https://api.smartsender.com/v1/contacts/{contactId}/notes/{noteId}

Sėkmingo atsakymo atveju gausite:

{
    "state": true
}

Documentation