Admin notes for a member (visible only to admins of the space). If a note is marked as "sticky", it is displayed on top of the list in the Cobot UI.

List Membership Notes

GET https://:subdomain.cobot.me/api/memberships/:membership_id/notes

Returns the list of notes for the membership.

Authentication required:

yes, additionally user must be a space admin

Scope required:

read_membership_notes

Example

URL:

GET  https://co-up.cobot.me/api/memberships/1d4d33ea2501579s146a6f12aeb56fbb/notes

Response:

[
  {
    "id": "3ea2501579s146a6f12ae",
    "text": "a very important note",
    "sticky": true,
    "author_name": "Jackie"
  },
  {
    "id": "0c4f75fa1492442381",
    "text": "less important note",
    "sticky": false,
    "author_name": "Jackie"
  }
]

Create Membership Note

POST https://:subdomain.cobot.me/api/memberships/:membership_id/notes

Creates a note for the membership and returns it's attributes. The author_name is set automatically based on admin name whose token was used to create it.

Authentication required:

yes, additionally user must be a space admin

Scope required:

write_membership_notes

Example

URL:

POST  https://co-up.cobot.me/api/memberships/1d4d33ea2501579s146a6f12aeb56fbb/notes

Body:

{
  "text": "some new note",
  "sticky": true
}

Response:

{
  "id": "3ea2501579s146a6f12ae",
  "text": "some new note",
  "sticky": true,
  "author_name": "Jackie"
}

Update Membership Note

PUT https://:subdomain.cobot.me/api/memberships/:membership_id/notes/:note_id

Update a membership note.

Authentication required:

yes, additionally user must be a space admin

Scope required:

write_membership_notes

Example

URL:

PUT  https://co-up.cobot.me/api/memberships/1d4d33ea2501579s146a6f12aeb56fbb/notes/4924423810d6f12aeb5

Body:

{
  "text": "this note became more important",
  "sticky": true
}

Response:

{
  "id": "4924423810d6f12aeb5",
  "text": "this note became more important",
  "sticky": true,
  "author_name": "Frank"
}

Delete Membership Note

DELETE https://:subdomain.cobot.me/api/memberships/:membership_id/notes/:note_id

Deletes a membership note.

Authentication required:

yes, additionally user must be a space admin

Scope required:

write_membership_notes

Example

URL:

DELETE  https://co-up.cobot.me/api/memberships/1d4d33ea2501579s146a6f12aeb56fbb/notes/4924423810d6f12aeb5

Response:

{
  "id": nil,
  "text": "some note",
  "sticky": true,
  "author_name": "Frank"
}