Inbox

Add an internal team note to a conversation; visitors never see it

Use an explicitly scoped user-bound account bearer credential or an application session. Scope grants are intersected with live membership, role, tenant isolation, agent access and plan limits; a credential does not grant an owner role. Invitation acceptance requires the verified recipient email.

post/workspaces/{workspaceId}/inbox/{conversationId}/notes

Request

  • Base URL: https://app.communicate.so/api/v1
  • URL: https://app.communicate.so/api/v1/workspaces/{workspaceId}/inbox/{conversationId}/notes
  • Auth: one of:
    • HTTP bearer
    • API key in cookie __Secure-better-auth.session_token
    • API key in cookie better-auth.session_token

Path parameters

workspaceIdstring required
conversationIdstring required

Request body

bodystring required

Response

Add an internal team note to a conversation; visitors never see it

idstring required
workspaceIdstring required
conversationIdstring required
authorIdstring required
authorMemberIdstring nullable required
authorWorkspaceIdstring nullable required
authorAgentGrantIdstring nullable required
authorKind'source_member' | 'linked_member' | 'system' required
audienceKind'source_only' | 'source_plus_author_destination' required
audienceDestinationWorkspaceIdstring nullable required
bodystring required
createdAtstring date-time required

Changes

No recorded changes to this operation across all 1 revision of this API.