Note
GET/v1/contacts/:contactId/notes/
https://rest.reisoftware.com/v1/contacts/:contactId/notes/
Get all contact notes.
Authorization:
Provide your location api key (Bearer Token).
AUTHORIZATION Bearer Token
Token
<token>
PATH VARIABLES
contactId
sx6wyHhbFdRXh302LLNR
(Required) Contact Id
Successful response
Example Request
curl --location --request GET 'https://rest.reisoftware.com/v1/contacts/sx6wyHhbFdRXh302LLNR/notes/' \
--header 'Authorization: Bearer <token>'
Example Response
200 OK
BodyHeader(1)
View More
{
"notes": [
{
"id": "Lj371SHlVMyfVlMcKiuk",
"body": "Loram ipsum",
"createdBy": "Loram ipsum",
"createdAt": "2020-10-20T12:52:17.561Z"
},
{
"id": "Lj371SHlVMyfVlMcKiuk",
"body": "Loram ipsum",
POST/v1/contacts/:contactId/notes/
https://rest.reisoftware.com/v1/contacts/:contactId/notes/
Create Notes.
Authorization:
Provide your location api key (Bearer Token).
AUTHORIZATION Bearer Token
Token
<token>
HEADERS
Content-Type
application/json
PATH VARIABLES
contactId
sx6wyHhbFdRXh302LLNR
(Required) Contact Id
BODYraw
{
"body": "lorem ipsum",
"userId": "GCs5KuzPqTls7vWclkEV"
}
Successful response
Example Request
curl --location --request POST 'https://rest.reisoftware.com/v1/contacts/sx6wyHhbFdRXh302LLNR/notes/' \
--header 'Authorization: Bearer <token>' \
--data-raw '{
"body": "lorem ipsum",
"userId": "GCs5KuzPqTls7vWclkEV"
}'
Example Response
200 OK
BodyHeader(1)
{
"id": "Lj371SHlVMyfVlMcKiuk",
"body": "Loram ipsum",
"createdBy": "Loram ipsum",
"createdAt": "2020-10-20T12:52:17.561Z"
}
GET/v1/contacts/:contactId/notes/:noteId
https://rest.reisoftware.com/v1/contacts/:contactId/notes/:noteId
Get note by id.
Authorization:
Provide your location api key (Bearer Token).
AUTHORIZATION Bearer Token
Token
<token>
PATH VARIABLES
contactId
sx6wyHhbFdRXh302LLNR
(Required) Contact Id
noteId
ocQHyuzHvysMo5N5VsXc
(Required) Note Id
Successful response
Example Request
curl --location --request GET 'https://rest.reisoftware.com/v1/contacts/sx6wyHhbFdRXh302LLNR/notes/ocQHyuzHvysMo5N5VsXc' \
--header 'Authorization: Bearer <token>'
Example Response
200 OK
BodyHeader(1)
{
"id": "Lj371SHlVMyfVlMcKiuk",
"body": "Loram ipsum",
"createdBy": "Loram ipsum",
"createdAt": "2020-10-20T12:52:17.561Z"
}
PUT/v1/contacts/:contactId/notes/:noteId
https://rest.reisoftware.com/v1/contacts/:contactId/notes/:noteId
Update Note.
Authorization:
Provide your location api key (Bearer Token).
AUTHORIZATION Bearer Token
Token
<token>
HEADERS
Content-Type
application/json
PATH VARIABLES
contactId
sx6wyHhbFdRXh302LLNR
(Required) Contact Id
noteId
ocQHyuzHvysMo5N5VsXc
(Required) Note Id
BODYraw
{
"body": "lorem ipsum",
"userId": "GCs5KuzPqTls7vWclkEV"
}
Successful response
Example Request
curl --location --request PUT 'https://rest.reisoftware.com/v1/contacts/sx6wyHhbFdRXh302LLNR/notes/ocQHyuzHvysMo5N5VsXc' \
--header 'Authorization: Bearer <token>' \
--data-raw '{
"body": "lorem ipsum",
"userId": "GCs5KuzPqTls7vWclkEV"
}'
Example Response
200 OK
BodyHeader(1)
{
"id": "Lj371SHlVMyfVlMcKiuk",
"body": "Loram ipsum",
"createdBy": "Loram ipsum",
"createdAt": "2020-10-20T12:52:17.561Z"
}
DEL/v1/contacts/:contactId/notes/:noteId
https://rest.reisoftware.com/v1/contacts/:contactId/notes/:noteId
Delete one of Notes.
Authorization:
Provide your location api key (Bearer Token).
AUTHORIZATION Bearer Token
Token
<token>
PATH VARIABLES
contactId
sx6wyHhbFdRXh302LLNR
(Required) Contact Id
noteId
ocQHyuzHvysMo5N5VsXc
(Required) Note Id
Successful response
Example Request
curl --location --request DELETE 'https://rest.reisoftware.com/v1/contacts/sx6wyHhbFdRXh302LLNR/notes/ocQHyuzHvysMo5N5VsXc' \
--header 'Authorization: Bearer <token>'
Example Response
200 OK
BodyHeader(1)
""