Activities (Notes)

Create activity

post/notes

Request

  • Base URL: https://api.pipelinecrm.com/api/v3
  • URL: https://api.pipelinecrm.com/api/v3/notes
  • Auth: one of:
    • HTTP bearer
    • HTTP bearer and API key in header app-key
    • API key in query parameter api_key and API key in query parameter app_key

Request body

Example request

{
  "note": {
    "created_at": "2026-09-01 14:22:07",
    "updated_at": "2026-09-01 14:22:07",
    "user_id": 13,
    "title": "Call with Jane about the renewal",
    "content": "This is the content",
    "deal_id": 4521,
    "company_id": 3310,
    "person_id": 8802,
    "milestone_id": 88,
    "comments": {
      "entries": [
        {
          "id": 771,
          "note_id": 9107,
          "user_id": 13,
          "comment": "Sent the revised quote.",
          "created_at": "2026-09-01 15:02:44",
          "updated_at": "2026-09-01 15:02:44",
          "edited_by_user_id": null,
          "user": {
            "id": 13,
            "first_name": "Sam",
            "last_name": "Okafor",
            "avatar_thumb_url": "https://app.pipelinecrm.com/avatars/13/thumb.png"
          }
        }
      ]
    },
    "note_category_id": 2,
    "notify_user_ids": [
      1,
      2,
      3,
      4,
      5
    ]
  }
}

Response

Successful Response

idinteger

Unique identifier

account_idinteger
possible_notify_user_idsinteger[]

The list of user_ids that can be added to notify_user_ids.

is_sent_messageboolean nullable

Describes if an activity with Email category is a sent or received message. It can also have a value of null for other activity categories.

primary_association_idinteger

The primary association model id of the note

primary_association_type'Deal' | 'Person' | 'Company'

The primary association type name

created_atstring

Timestamp when the record was created (time zone in user's time zone).

updated_atstring

Timestamp when the record was last touched (time zone in user's time zone).

user_idinteger

The owner of the note

titlestring nullable

The note title, if any

contentstring

The note content

deal_idinteger nullable

The deal id of the note

company_idinteger nullable

The company id of the note

person_idinteger nullable

The person id of the note

milestone_idinteger
note_category_idinteger nullable

The category of the note

notify_user_idsinteger[]

These are the ids of the users who will receive emails when new comments are added to the given note/activity.

Example response

{
  "id": 9903,
  "account_id": 2081,
  "possible_notify_user_ids": [
    1,
    2,
    3,
    4,
    5
  ],
  "primary_association_id": 4521,
  "primary_association_type": "Deal",
  "user": {
    "id": 13,
    "first_name": "Sam",
    "last_name": "Okafor"
  },
  "note_category": {
    "id": 2,
    "name": "Call"
  },
  "created_at": "2026-09-01 14:22:07",
  "updated_at": "2026-09-01 14:22:07",
  "user_id": 13,
  "title": "Call with Jane about the renewal",
  "content": "This is the content",
  "deal_id": 4521,
  "company_id": 3310,
  "person_id": 8802,
  "milestone_id": 88,
  "comments": {
    "entries": [
      {
        "id": 771,
        "note_id": 9107,
        "user_id": 13,
        "comment": "Sent the revised quote.",
        "created_at": "2026-09-01 15:02:44",
        "updated_at": "2026-09-01 15:02:44",
        "edited_by_user_id": null,
        "user": {
          "id": 13,
          "first_name": "Sam",
          "last_name": "Okafor",
          "avatar_thumb_url": "https://app.pipelinecrm.com/avatars/13/thumb.png"
        }
      }
    ]
  },
  "note_category_id": 2,
  "notify_user_ids": [
    1,
    2,
    3,
    4,
    5
  ]
}

Changes

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