Adds a note to a contact.

​

Usage Example

POST /api/v1/network/contacts/123/notes
Content-Type: application/json

{
  "note": "Follow-up call scheduled for next week",
  "fileId": 789
}

Validation Rules

  • note: Required, 1-10000 characters
  • fileId: Optional, must be a file owned by authenticated user

Idempotency

Supports Idempotency-Key header to prevent duplicate notes:

POST /api/v1/network/contacts/123/notes
Idempotency-Key: 550e8400-e29b-41d4-a716-446655440000

{
  "note": "Important update"
}

Retry with same key returns 204 (success) without creating duplicate.

Path Parameters
  • id
    Type: string
    required

    Contact ID

Body·
required

Note content and optional file attachment

Request to add a note to a contact or company

  • note
    Type: string
    max length:  
    10000
    required

    The note text

  • fileId
    Type: null | string

    Optional file attachment ID (must be owned by authenticated user)

  • type
    Type: null | string

    Activity sub-type: "note" (default), "call", "meeting", "email", "news"

Responses
  • 204

    Note added successfully

  • application/problem+json
  • application/problem+json
  • application/problem+json
  • application/problem+json
Request Example for post/api/v1/network/contacts/{id}/notes
curl 'https://app.propstreet.com/api/v1/network/contacts/{id}/notes' \
  --request POST \
  --header 'Content-Type: application/json' \
  --header 'Authorization: Bearer YOUR_SECRET_TOKEN' \
  --data '{
  "note": "",
  "fileId": null,
  "type": null
}'
No Body

Note added successfully

Propstreet API Documentation