Skip to content
vocapable.Docs

Save a shared team note

POST
/v1/workspace/organizations/{organization_id}/notes
curl --request POST \
  --url https://api.vocapable.com/v1/workspace/organizations/example/notes \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '{ "body": "example", "contact_id": "example" }'

The note, its timeline entry and the removal of your private note draft commit together. If anything fails nothing is saved and your draft is still there.

Authorizations

Section titled “Authorizations”

Parameters

Section titled “Parameters”

Path Parameters

Section titled “Path Parameters”
organization_id
required
Organization Id
string

Header Parameters

Section titled “Header Parameters”
Idempotency-Key
Any of:
string

Unique key for this request, so a retry replays the original result instead of repeating the work. Stored for 24 hours; a replayed response carries Idempotent-Replay: true. A UUID is the documented shape.

Request Bodyrequired

Section titled “Request Bodyrequired”
Media typeapplication/json
WorkspaceNoteCreate
object
body
required
Body
string
>= 1 characters <= 10000 characters
contact_id
Any of:
string
Examplegenerated
{
  "body": "example",
  "contact_id": "example"
}

Responses

Section titled “Responses”

201

Section titled “201”

Successful Response

Media typeapplication/json
WorkspaceNote

A shared team note: every teammate who can see the relationship can read it.

object
id
required
Id
string
organization_id
required
Organization Id
string
contact_id
required
Any of:
string
author
required
Any of:
WorkspacePersonRef

A teammate named on a record: the id the server holds and the name to show.

object
user_id
required
User Id
string
name
required
Name
string
body
required
Body
string
visibility
required
Visibility
string
Allowed value: team
revision
required
Revision
integer
created_at
required
Created At
string format: date-time
updated_at
required
Updated At
string format: date-time
Example
{
  "visibility": "team"
}

422

Section titled “422”

Validation Error

Media typeapplication/json
HTTPValidationError
object
detail
Detail
Array<object>
ValidationError
object
loc
required
Location
Array
msg
required
Message
string
type
required
Error Type
string
input
Input
ctx
Context
object
Examplegenerated
{
  "detail": [
    {
      "loc": [
        "example"
      ],
      "msg": "example",
      "type": "example",
      "input": "example",
      "ctx": {}
    }
  ]
}