Notes API
This API is used to get note, add note, edit note, delete note, etc. in the Sales CRM module.
Get Note with Paginated
Method | GET |
Media Type | application/json |
URL | http://[server]/dolphin/apiv1/graph/notes?start=0&count=2 |
Header | Authorization : Bearer [generatedToken] |
Body | |
Status | 200 |
Response | { “status”: “success”, “data”: [ { “id”: “[id]”, “owner”: “[owner_id]”, “createdDate”: 1594277620645, “createdBy”: “92bf95da600aa062f833643aa8783462”, “modifiedDate”: 1594277620645, “modifiedBy”: “92bf95da600aa062f833643aa8783462”, “relationId”: “[relation_id]”, “relationType”: “sales-contact”, “note”: “ bisa ini“ }, { “id”: “[id]”, “owner”: “[owner_id]”, “createdDate”: 1594364920261, “createdBy”: “760e1b75a9b4217cb1d75b714c10e263”, “modifiedDate”: 1594364920261, “modifiedBy”: “760e1b75a9b4217cb1d75b714c10e263”, “relationId”: “[relation_id]”, “relationType”: “sales-contact”, “note”: “ a“ } ], “hasMore”: true, “nextIndex”: 2, “prevIndex”: 0, “totalResults”: 403 } |
Get Note by Note Id
Method | GET |
Media Type | application/json |
URL | http://[server]/dolphin/apiv1/graph/notes/[note_id] |
Header | Authorization : Bearer [generatedToken] noteId : [note_id] |
Body | |
Status | 200 |
Response | { “status”: “success”, “data”: { “id”: “[id]”, “owner”: “[owner_id]”, “createdDate”: 1594379231857, “createdBy”: “8e8c2328425057241e808b6abe6881da”, “modifiedDate”: 1594379305533, “modifiedBy”: “8e8c2328425057241e808b6abe6881da”, “relationId”: “[relation_id]”, “relationType”: “[relation_type]”, “note”: “ Edited by me testing add new note testing add new note testing add new note testing add new note sdf“ }, “hasMore”: false, “nextIndex”: 0, “prevIndex”: 0, “totalResults”: 0 } |
Add Note
To add notes according to relation type. The relationship type is divided into four (4) namely company, sales-contact, product and deal. If the relation type is sales-contact, the note added will appear in the contact detail.
Method | POST |
Media Type | application/json |
URL | http://[server]/dolphin/apiv1/graph/auxiliarys/agents/unavailable?count=1 |
Header | Authorization : Bearer [generatedToken] |
Body | Body Example : { “relationId”: “[relation_id]”, “relationType”: “[sales-contact, company, product, deal]”, “note”: “Add Note Melalui API” } |
Status | 200 |
Response | { “status”: “success”, “data”: { “id”: “[id]”, “owner”: “[owner_id]”, “createdDate”: 1603277774603, “createdBy”: “ac2c37cf90ee51edf54b2e4bc2298e03”, “modifiedDate”: 1603277774603, “modifiedBy”: “ac2c37cf90ee51edf54b2e4bc2298e03”, “relationId”: “[relation_id]”, “relationType”: “sales-contact”, “note”: “Add Note Melalui API” }, “hasMore”: false, “nextIndex”: 0, “prevIndex”: 0, “totalResults”: 0 } |
Edit Note
Method | PUT |
Media Type | application/json |
URL | http://[server]/dolphin/apiv1/graph/notes/edit |
Header | Authorization : Bearer [generatedToken] |
Body | Body Example : { “id”: “[id]”, “relationId”: “[relation_id]”, “relationType”: “[relation_type]”, “note”: “[note]” } |
Status | 200 |
Response | { “status”: “success”, “data”: { “id”: “[id]”, “owner”: “[owner_id]”, “createdDate”: 1603262743506, “createdBy”: “ac2c37cf90ee51edf54b2e4bc2298e03”, “modifiedDate”: 1603262743506, “modifiedBy”: “ac2c37cf90ee51edf54b2e4bc2298e03”, “relationId”: “[relation_id]”, “relationType”: “sales-contact”, “note”: “update notes melalui API” }, “hasMore”: false, “nextIndex”: 0, “prevIndex”: 0, “totalResults”: 0 } |
Delete Note
Method | PUT |
Media Type | application/json |
URL | http://[server]/dolphin/apiv1/graph/notes/delete/[note_id] |
Header | Authorization : Bearer [generatedToken] noteId |
Body | |
Status | 200 |
Response | { “status”: “success”, “data”: “Note Deleted”, “hasMore”: false, “nextIndex”: 0, “prevIndex”: 0, “totalResults”: 0 } |
Last updated