Nooks

Nooks Notes API

Create CRM notes on prospects and accounts

Documentation GitHub OpenAPI

Operations 2

POST /prospects/{id}/notes Create a prospect note #

POST /accounts/{id}/notes Create an account note #

Work with this as data

Every API here is available over the APIs.io API and to AI agents over MCP.

MCP server

One button, every client — Claude, Cursor, VS Code and the rest.

https://apis.io/mcp

Tools for apis

7 MCP tools reach this

find_apisBrowse and filter every API in the catalog.
get_api_artifactsOne API's artifacts, grouped by type.
get_openapiThe primary OpenAPI for this API.
find_similar_apisAPIs that look like this one.
apis_io_searchSTART HERE — APIs, providers and tags for one query, each with its total.
resolveTurn a domain, URL or GitHub org into the provider it belongs to.
find_cohortsEvery scored population of providers in the catalog.

All 92 tools →

Call it yourself

curl for this page

This API

curl "https://apis.io/api/v1/apis/nooks-notes-api"

All apis

curl "https://apis.io/api/v1/apis?limit=25"

Discovery needs no key. Ratings and market analysis are Pro.

Get an API key

Free tier, no form to fill in. Signing in shares your email address with us — we store it to create your key and to recognise you if you sign in with another provider. See our Privacy Policy and Terms.

GitHub Google LinkedIn

A second provider on the same verified email joins the account you already have.

OpenAPI Specification

openapi: 3.2.0
info:
  title: Nooks Sequencing Notes API
  version: 0.1.0
  description: The Nooks Sequencing API provides programmatic access to manage sequences, tasks, templates, and prospect engagement workflows created using the Nooks SEP.
  contact:
    name: Nooks API Support
    email: support@nooks.in
    url: https://www.nooks.in
  license:
    name: Proprietary
  x-logo:
    url: ./nooks-logo.svg
    altText: Nooks Logo
    href: https://www.nooks.ai
servers:
- url: https://partner-api.nooks.in/v1
  description: Production API
security:
- BearerAuth: []
tags:
- name: Notes
  description: Create CRM notes on prospects and accounts
paths:
  /prospects/{id}/notes:
    post:
      operationId: createProspectNote
      summary: Create a prospect note
      description: '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.


        Example:

        ```bash

        curl -X POST ''https://partner-api.nooks.in/v1/prospects/990e8400-e29b-41d4-a716-446655440020/notes'' \

        -H "Authorization: Bearer nooks-api-..." \

        -H "Content-Type: application/json" \

        -d ''{

        "data": {

        "text": "Follow up after legal review.",

        "integrationType": "salesforce"

        }

        }''

        ```'
      tags:
      - Notes
      parameters:
      - name: id
        in: path
        required: true
        description: Unique identifier for the prospect
        schema:
          type: string
          format: uuid
        example: 990e8400-e29b-41d4-a716-446655440020
      requestBody:
        required: true
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/CreateNoteRequest'
            example:
              data:
                text: Follow up after legal review.
                integrationType: salesforce
      responses:
        '201':
          description: Note successfully created
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Note'
              example:
                id: bb0e8400-e29b-41d4-a716-446655440080
                externalId: 00TABC123DEF456
                text: Follow up after legal review.
                associatedType: prospect
                associated:
                  id: 990e8400-e29b-41d4-a716-446655440020
                  _href: /v1/prospects/990e8400-e29b-41d4-a716-446655440020
                integrationType: salesforce
                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'
        '400':
          description: Malformed body (`Error`), or the CRM isn't usable for the acting user (`NO_CRM_CONNECTION`). See the `NoCrmConnectionError` schema.
          content:
            application/json:
              schema:
                anyOf:
                - $ref: '#/components/schemas/Error'
                - $ref: '#/components/schemas/NoCrmConnectionError'
              example:
                error:
                  code: NO_CRM_CONNECTION
                  message: The user this request acts as has no salesforce connection in Nooks. Connect salesforce for that user and try again — API-key requests act as a workspace admin.
                  integrationType: salesforce
                traceId: 6b1c9f2e8d3a4c5b7e9f0a1d2c3b4a5e
        '401':
          $ref: '#/components/responses/Unauthorized'
        '404':
          $ref: '#/components/responses/NotFound'
        '422':
          description: 'Unprocessable entity. Possible causes:

            - `integrationType` does not match the prospect''s CRM source

            - The CRM rejected the note creation request

            '
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error'
              example:
                error:
                  code: UNPROCESSABLE_ENTITY
                  message: Unprocessable entity
                  details:
                    message: integrationType must match the prospect source (hubspot)
        '429':
          $ref: '#/components/responses/RateLimitExceeded'
        '500':
          $ref: '#/components/responses/InternalError'
  /accounts/{id}/notes:
    post:
      operationId: createAccountNote
      summary: Create an account note
      description: 'Creates a CRM note on a CRM-backed account. The account must be

        sourced from Salesforce or HubSpot, and `data.integrationType` must

        match that CRM source.


        Example:

        ```bash

        curl -X POST ''https://partner-api.nooks.in/v1/accounts/aa0e8400-e29b-41d4-a716-446655440030/notes'' \

        -H "Authorization: Bearer nooks-api-..." \

        -H "Content-Type: application/json" \

        -d ''{

        "data": {

        "text": "Champion moved teams; confirm new buying committee.",

        "integrationType": "hubspot"

        }

        }''

        ```'
      tags:
      - Notes
      parameters:
      - name: id
        in: path
        required: true
        description: Unique identifier for the account
        schema:
          type: string
          format: uuid
        example: aa0e8400-e29b-41d4-a716-446655440030
      requestBody:
        required: true
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/CreateNoteRequest'
            example:
              data:
                text: Champion moved teams; confirm new buying committee.
                integrationType: hubspot
      responses:
        '201':
          description: Note successfully created
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Note'
              example:
                id: cc0e8400-e29b-41d4-a716-446655440081
                externalId: '28491827364'
                text: Champion moved teams; confirm new buying committee.
                associatedType: account
                associated:
                  id: aa0e8400-e29b-41d4-a716-446655440030
                  _href: /v1/accounts/aa0e8400-e29b-41d4-a716-446655440030
                integrationType: hubspot
                userExternalId: null
                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'
        '400':
          description: Malformed body (`Error`), or the CRM isn't usable for the acting user (`NO_CRM_CONNECTION`). See the `NoCrmConnectionError` schema.
          content:
            application/json:
              schema:
                anyOf:
                - $ref: '#/components/schemas/Error'
                - $ref: '#/components/schemas/NoCrmConnectionError'
              example:
                error:
                  code: NO_CRM_CONNECTION
                  message: The user this request acts as has no hubspot connection in Nooks. Connect hubspot for that user and try again — API-key requests act as a workspace admin.
                  integrationType: hubspot
                traceId: 6b1c9f2e8d3a4c5b7e9f0a1d2c3b4a5e
        '401':
          $ref: '#/components/responses/Unauthorized'
        '404':
          $ref: '#/components/responses/NotFound'
        '422':
          description: 'Unprocessable entity. Possible causes:

            - `integrationType` does not match the account''s CRM source

            - The CRM rejected the note creation request

            '
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error'
              example:
                error:
                  code: UNPROCESSABLE_ENTITY
                  message: Unprocessable entity
                  details:
                    message: CRM rejected the note creation request
        '429':
          $ref: '#/components/responses/RateLimitExceeded'
        '500':
          $ref: '#/components/responses/InternalError'
components:
  responses:
    RateLimitExceeded:
      description: 'Rate limit exceeded. May reflect either the per-workspace Nooks

        rate limit (see headers in the rate-limiting section) or an

        upstream CRM (Salesforce / HubSpot) rate limit hit while

        servicing the request. Retry after the `Retry-After` interval.

        '
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/Error'
          example:
            error:
              code: RATE_LIMIT_EXCEEDED
              message: Rate limit exceeded
    Unauthorized:
      description: Unauthorized - invalid or missing API key
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/Error'
          example:
            error:
              code: UNAUTHORIZED
              message: Invalid or missing API key
    NotFound:
      description: Resource not found
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/Error'
          example:
            error:
              code: NOT_FOUND
              message: The requested resource was not found
    InternalError:
      description: Internal server error
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/Error'
          example:
            error:
              code: INTERNAL_ERROR
              message: An unexpected error occurred
  schemas:
    Note:
      type: object
      description: A CRM note created through Nooks.
      properties:
        id:
          type: string
          format: uuid
          description: Unique identifier for the Nooks note record.
          example: bb0e8400-e29b-41d4-a716-446655440080
        externalId:
          type: string
          description: Unique identifier for the note in the destination CRM.
          example: 00TABC123DEF456
        text:
          type: string
          description: Note body text.
          example: Follow up after legal review.
        associatedType:
          type: string
          enum:
          - prospect
          - account
          description: Type of resource the note is associated with.
          example: prospect
        associated:
          $ref: '#/components/schemas/ReferenceObject'
        integrationType:
          $ref: '#/components/schemas/CrmNoteIntegrationType'
        userExternalId:
          type: string
          nullable: true
          description: External CRM user identifier for the user who authored the note, when available.
          example: 005ABC123DEF456
        userName:
          type: string
          nullable: true
          description: Display name for the user who authored the note, when available.
          example: Sam Seller
        externalCreatedAt:
          type: string
          format: date-time
          description: When the note was created in the destination CRM.
          example: '2026-07-09T16:00:00.000Z'
        externalUpdatedAt:
          type: string
          format: date-time
          description: When the note was last updated in the destination CRM.
          example: '2026-07-09T16:00:00.000Z'
        createdAt:
          type: string
          format: date-time
          description: When the Nooks note record was created.
          example: '2026-07-09T16:00:01.000Z'
        updatedAt:
          type: string
          format: date-time
          description: When the Nooks note record was last updated.
          example: '2026-07-09T16:00:01.000Z'
      required:
      - id
      - externalId
      - text
      - associatedType
      - associated
      - integrationType
      - userExternalId
      - userName
      - externalCreatedAt
      - externalUpdatedAt
      - createdAt
      - updatedAt
    CrmNoteIntegrationType:
      type: string
      enum:
      - salesforce
      - hubspot
      description: The CRM integration where the note should be created.
    NoCrmConnectionError:
      type: object
      description: 'Returned (400) when the requested CRM isn''t usable — never connected, token/session expired/revoked, or the acting user has no connection of their own. `message` carries the remediation, so branch on `code`, not `message`.

        '
      properties:
        error:
          type: object
          properties:
            code:
              type: string
              enum:
              - NO_CRM_CONNECTION
              example: NO_CRM_CONNECTION
            message:
              type: string
              description: Human-readable remediation text; display-only (do not parse).
              example: Your salesforce connection is no longer valid. Reconnect salesforce in Nooks.
            integrationType:
              $ref: '#/components/schemas/SyncableCrmType'
          required:
          - code
          - message
          - integrationType
        traceId:
          type: string
          description: Request trace id, for correlating with Nooks support.
          example: 6b1c9f2e8d3a4c5b7e9f0a1d2c3b4a5e
      required:
      - error
    Error:
      type: object
      description: Standard error response
      properties:
        error:
          type: object
          properties:
            code:
              type: string
              description: Error code
              example: NOT_FOUND
            message:
              type: string
              description: Human-readable error message
              example: The requested resource was not found
        traceId:
          type: string
          description: 'Request trace identifier for correlating this error with server

            logs and support requests. Present whenever the request carried a

            trace context (the normal case); omitted otherwise.

            '
          example: abc123def456
    CreateNoteRequest:
      type: object
      description: Request body for creating a CRM note.
      additionalProperties: false
      properties:
        data:
          type: object
          additionalProperties: false
          properties:
            text:
              type: string
              minLength: 1
              maxLength: 65535
              description: Note body text. Must contain at least one non-whitespace character.
              example: Follow up after legal review.
            integrationType:
              $ref: '#/components/schemas/CrmNoteIntegrationType'
          required:
          - text
          - integrationType
      required:
      - data
    SyncableCrmType:
      type: string
      enum:
      - salesforce
      - hubspot
      description: The CRM integration to sync from.
    ReferenceObject:
      type: object
      description: A reference to a related resource
      properties:
        id:
          type: string
          description: Unique identifier of the referenced resource
          example: 550e8400-e29b-41d4-a716-446655440000
        _href:
          type: string
          description: API path to the referenced resource
          example: /v1/sequences/550e8400-e29b-41d4-a716-446655440000
      required:
      - id
      - _href
  securitySchemes:
    BearerAuth:
      type: http
      scheme: bearer
      description: 'Bearer token sent in the `Authorization` header. Accepts either a

        long-lived Nooks API key (`nooks-api-...`, from Developer Settings →

        API Keys) or an OAuth 2.0 access token issued by

        `https://oauth.nooks.in`. Use whichever you already have — the API

        validates both formats on the same header. For full OAuth flow

        details (authorize/token endpoints, scopes, refresh behavior) see

        the Authentication section of this spec''s introduction.

        '
x-tagGroups:
- name: API Reference
  tags:
  - Sequences
  - SequenceSteps
  - Emails
  - Users
  - SequenceStates
  - Prospects
  - Accounts
  - Notes
  - Mailboxes
  - Calls
  - CallDispositions
  - Tasks
  - EmailTemplates
  - Introspection