OnAutomate API V1.1.1
Welcome to onautomate Api docs.
Note
GET /v1/contacts/:contactId/notes/
https://link.amtssl.com/v1/contacts/:contactId/notes/
AUTHORIZATION
Bearer Token
Token
<token>
PATH VARIABLES
contactId
sx6wyHhbFdRXh302LLNR
(Required) Contact Id
Example Request
curl --location --request GET 'https://link.amtssl.com/v1/contacts/:contactId/notes/' \
--header 'Authorization: Bearer <token>'
Example Response
Bad Request. please contact support!
Successful response
Unauthorized
400 Bad Request
BODY
{
"msg": "Bad Request"
}
200 OK
BODY
{
"notes": [
{
"id": "Lj371SHlVMyfVlMcKiuk",
"body": "Loram ipsum",
"createdAt": "2020-10-20T12:52:17.561Z"
},
{
"id": "Lj371SHlVMyfVlMcKiuk",
"body": "Loram ipsum",
"createdAt": "2020-10-20T12:52:17.561Z"
}
]
}
400 Bad Request
BODY
{
"msg": "Unauthorized"
}
Headers
Content-Type: application/json
Headers
Content-Type: application/json
Headers
Content-Type: application/json
POST /v1/contacts/:contactId/notes/
https://link.amtssl.com/v1/contacts/:contactId/notes/
AUTHORIZATION
Bearer Token
Token
<token>
HEADERS
Content-type
application/json
PATH VARIABLES
contactId
sx6wyHhbFdRXh302LLNR
(Required) Contact Id
BODY raw
{
"body": "lorem ipsum"
}
Example Request
curl --location --request POST 'https://link.amtssl.com/v1/contacts/:contactId/notes/' \
--header 'Authorization: Bearer <token>' \
--data-raw '{
"body": "lorem ipsum"
}'
Example Response
Bad Request. please contact support!
Unprocessable Entity
Successful response
Unauthorized
400 Bad Request
BODY
{
"msg": "Bad Request"
}
422 Unprocessable Entity (WebDAV) (RFC 4918)
BODY
{
"body": {
"message": "The body field is mandatory.",
"rule": "required"
}
}
200 OK
BODY
{
"id": "Lj371SHlVMyfVlMcKiuk",
"body": "Loram ipsum",
"createdAt": "2020-10-20T12:52:17.561Z"
}
401 Unauthorized
BODY
{
"msg": "Unauthorized"
}
Headers
Content-Type: application/json
Headers
Content-Type: application/json
Headers
Content-Type: application/json
Headers
Content-Type: application/json
GET /v1/contacts/:contactId/notes/:noteId
https://link.amtssl.com/v1/contacts/:contactId/notes/:noteId
AUTHORIZATION
Bearer Token
Token
<token>
PATH VARIABLES
contactId
sx6wyHhbFdRXh302LLNR
(Required) Contact Id
noteId
ocQHyuzHvysMo5N5VsXc
(Required) Note Id
Example Request
curl --location --request GET 'https://link.amtssl.com/v1/contacts/:contactId/notes/:noteId' \
--header 'Authorization: Bearer <token>'
Example Response
Unauthorized
Successful response
Bad Request. please contact support!
401 Unauthorized
BODY
{
"msg": "Unauthorized"
}
200 OK
BODY
{
"id": "Lj371SHlVMyfVlMcKiuk",
"body": "Loram ipsum",
"createdAt": "2020-10-20T12:52:17.561Z"
}
400 Bad Request
BODY
{
"msg": "Bad Request"
}
Headers
Content-Type: application/json
Headers
Content-Type: application/json
Headers
Content-Type: application/json
PUT /v1/contacts/:contactId/notes/:noteId
https://link.amtssl.com/v1/contacts/:contactId/notes/:noteId
AUTHORIZATION
Bearer Token
Token
<token>
HEADERS
Content-Type
application/json
PATH VARIABLES
contactId
sx6wyHhbFdRXh302LLNR
(Required) Contact Id
noteId
ocQHyuzHvysMo5N5VsXc
(Required) Note Id
BODY raw
{
"body": "lorem ipsum"
}
Example Request
curl --location --request PUT 'https://link.amtssl.com/v1/contacts/:contactId/notes/:noteId' \
--header 'Authorization: Bearer <token>' \
--data-raw '{
"body": "lorem ipsum"
}'
Example Response
Unauthorized
Unprocessable Entity
Successful response
Bad Request. please contact support!
401 Unauthorized
BODY
{
"msg": "Unauthorized"
}
422 Unprocessable Entity (WebDAV) (RFC 4918)
BODY
{
"body": {
"message": "The body field is mandatory.",
"rule": "required"
}
}
200 OK
BODY
{
"id": "Lj371SHlVMyfVlMcKiuk",
"body": "Loram ipsum",
"createdAt": "2020-10-20T12:52:17.561Z"
}
400 Bad Request
BODY
{
"msg": "Bad Request"
}
Headers
Content-Type: application/json
Headers
Content-Type: application/json
Headers
Content-Type: application/json
Headers
Content-Type: application/json
DEL /v1/contacts/:contactId/notes/:noteId
https://link.amtssl.com/v1/contacts/:contactId/notes/:noteId
AUTHORIZATION
Bearer Token
Token
<token>
PATH VARIABLES
contactId
sx6wyHhbFdRXh302LLNR
(Required) Contact Id
noteId
ocQHyuzHvysMo5N5VsXc
(Required) Note Id
Example Request
curl --location --request DELETE 'https://link.amtssl.com/v1/contacts/:contactId/notes/:noteId' \
--header 'Authorization: Bearer <token>'
Example Response
Unauthorized
Bad Request. please contact support!
Successful response
401 Unauthorized
{
"msg": "Unauthorized"
}
401 Unauthorized
{
"msg": "Unauthorized"
}
401 Unauthorized
""
Headers
Content-Type: application/json
Headers
Content-Type: application/json
Headers
Content-Type: application/json