Contact Notes API - lv

Izmantojot šo API, varat skatīt, rediģēt, izveidot un dzēst atlasītās kontaktpersonas piezīmes.

 

Lasīšana.

Saņemiet izveidoto piezīmju sarakstu kontaktpersonai.

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

Galvenie parametri:

Vārds

Apraksts

Validācija

Vārds

Apraksts

Validācija

page

Pieprasītā lapa

Minimālā vērtība 1

limitation

Lapā parādāmo datu apjoms

Minimālā vērtība 1, maksimālā 20

Veiksmīgas atbildes gadījumā saņemsiet sekojošo:

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

Atbildes apraksts:

Vārds

Apraksts

Vārds

Apraksts

cursor

Cursor objekts

collection

Note objektu masīvs

 

Radīšana.

Izveidojiet piezīmi kontaktpersonai.

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

Galvenie parametri:

Vārds

Apraksts

Vārds

Apraksts

text

Piezīmes apraksts

Veiksmīgas atbildes gadījumā iegūstiet tipa objektu Note

 

Atjaunināt.

Ļauj atjaunināt kontaktpersonas atlasītās piezīmes.

 

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

Veiksmīgas atbildes gadījumā saņemsiet sekojošo:

{ "state": true }

 

Noņemšana.

Ļauj izdzēst atlasīto piezīmi no kontaktpersonas.

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

Veiksmīgas atbildes gadījumā saņemsiet sekojošo:

{ "state": true }