Api Documentation

User notes

User notes belonging to the logged in user. For privacy reasons, user authentication is always required for this endpoint.
listWith user authenticationchevron_right
Retrieves a collection of user notes
singleWith user authenticationchevron_right
Retrieves a single user note
createWith user authenticationchevron_right
Creates a new user note.
updateWith user authenticationchevron_right
Updates a user note.
deleteWith user authenticationchevron_right
Deletes a single user note.
Json
XML
POST https://api.bundeling.com/V2/user_notes

Parameters

Body

NameDescriptionTypeNillableRequired
object_typeThe type of object this note is for
Accepted values: user
stringfalsetrue
object_uuidA unique identifier used to identify the objectstringfalsetrue
noteThe notestringfalsefalse

Example request

Headers

Content-Type:application/json
Api-Key:RAegSX8yZfEbqSPM

Body

{
    "object_type": "user",
    "object_uuid": "d7743aaf53224e279853c7d0c1dbfb3a",
    "note": "Potential lead"
}

Example response

{
    "uuid": "eeb763c41c054dcc8f6d9362f24ee9b2",
    "object_type": "user",
    "object_uuid": "d7743aaf53224e279853c7d0c1dbfb3a",
    "note": "Potential lead",
    "creationdate": "2024-01-20T00:00:00+0100",
    "lastupdate": "2024-01-20T00:00:00+0100"
}