Notes

Create a prospect note

Creates a CRM note on a CRM-backed prospect. The prospect must be sourced from Salesforce or HubSpot, and data.integrationType must match that CRM source.

post/prospects/{id}/notes

Request

  • Base URL: https://partner-api.nooks.in/v1
  • URL: https://partner-api.nooks.in/v1/prospects/{id}/notes
  • Auth: one of:
    • HTTP bearer
    • OAuth 2 (authorization code, authorization URL https://oauth.nooks.in/oauth/authorize, token URL https://oauth.nooks.in/oauth/token, scopes: notes:write)

Path parameters

idstring uuid required

Unique identifier for the prospect

Request body

Example request

{
  "data": {
    "text": "Follow up after legal review."
  }
}

Response

Note successfully created

idstring uuid required

Unique identifier for the Nooks note record.

externalIdstring required

Unique identifier for the note in the destination CRM.

textstring required

Note body text.

associatedType'prospect' | 'account' required

Type of resource the note is associated with.

integrationType'salesforce' | 'hubspot' required

The CRM integration where the note should be created.

userExternalIdstring nullable required

External CRM user identifier for the user who authored the note, when available.

userNamestring nullable required

Display name for the user who authored the note, when available.

externalCreatedAtstring date-time required

When the note was created in the destination CRM.

externalUpdatedAtstring date-time required

When the note was last updated in the destination CRM.

createdAtstring date-time required

When the Nooks note record was created.

updatedAtstring date-time required

When the Nooks note record was last updated.

Example response

{
  "id": "bb0e8400-e29b-41d4-a716-446655440080",
  "externalId": "00TABC123DEF456",
  "text": "Follow up after legal review.",
  "associatedType": "prospect",
  "associated": {
    "id": "550e8400-e29b-41d4-a716-446655440000",
    "_href": "/v1/sequences/550e8400-e29b-41d4-a716-446655440000"
  },
  "userExternalId": "005ABC123DEF456",
  "userName": "Sam Seller",
  "externalCreatedAt": "2026-07-09T16:00:00.000Z",
  "externalUpdatedAt": "2026-07-09T16:00:00.000Z",
  "createdAt": "2026-07-09T16:00:01.000Z",
  "updatedAt": "2026-07-09T16:00:01.000Z"
}

Changes

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