Skip to end of metadata
Go to start of metadata

You are viewing an old version of this page. View the current version.

Compare with Current View Page History

Version 1 Current »

With this API, you can view, edit, create, and delete notes for the selected contact.

Reading.

Get a list of created notes for a contact. 

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

 


Main parameters:

Name

Description

Validation

page

Requested Page

Minimum value 1

limitation

Amount of data to display per page

Minimum value 1, maximum 20

 
In case of a successful response, you will receive the following:

 

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


Answer description:

Name

Description

cursor

Object of type Cursor

collection

Array of objects of type Note

 

Creation.

Create a note for a contact.

 

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

 


Main parameters:

Name

Description

text

Note Description

 

In case of a successful response, get an object of type Note.

 

Update.

Allows you to update the selected notes of the contact.

 

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


In case of a successful response, you will receive the following:

 

{
    "state": true
}

 

Deletion.

Allows you to delete the selected note from the contact.

 

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


In case of a successful response, you will receive the following:

 

{
    "state": true
}

 

  • No labels