CRM Notes

POST

/api/v1/workspaces/{workspaceId}/crm/{objectSlug}/records/{recordId}/notes

Scope crm:write

Create a note on a CRM record. The body can be plain text or rich text, and the note can be pinned.

Pfad

workspaceIdPflicht

string (uuid)

Workspace that owns the resource.

objectSlugPflicht

string

CRM object slug, for example contact.

recordIdPflicht

string (uuid)

CRM record identifier.

Request

application/json · CrmNoteCreateDto

bodyPflicht

string

Body content.

bodyFormat

CrmNoteBodyFormat

isPinned

boolean

Whether this is pinned.

Antworten

200CrmNoteDtoThe request succeeded. The JSON body contains url, data, and meta. The linked schema is data.

CRM note.

string (uuid)

Identifier.

recordId

string (uuid)

Identifier of the record.

bodyPflicht

string

Body content.

bodyFormat

CrmNoteBodyFormat

isPinned

boolean

Whether this is pinned.

createdByUserId

string (uuid)

Member who created this.

updatedByUserId

string (uuid)

Member who last updated this.

createdAt

string (date-time)

When this was created.

updatedAt

string (date-time)

When this was last updated.

400ApiProblemThe request is invalid.

401ApiProblemThe private app token is missing or invalid.

403ApiProblemThe token is missing the required scope, or this action is not allowed.

404ApiProblemThe workspace or resource was not found.

defaultApiProblemError response.