Add an internal note to the need

POST

/api/needs/{id}/notes

curl --request POST \
  --url https://example.com/api/needs/2489E9AD-2EE2-8E00-8EC9-32D5F69181C0/notes \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '{ "content": "Scheduled food box pickup for Thursday at 2:00 PM." }'

Authorizations

• BearerAuth

Parameters

Path Parameters

id

required

string format: uuid

Request Body^required

Media typeapplication/json

object

content

required

Body text of the interaction message or note.

string

Example

Scheduled food box pickup for Thursday at 2:00 PM.

Responses

201

Note added successfully

Media typeapplication/json

object

id

required

Unique identifier (UUID v4) for the resource.

string format: uuid

organizationId

required

Unique identifier (UUID v4) for the parent organization.

string format: uuid

partnerId

Unique identifier (UUID v4) for the assigned partner location facility.

string format: uuid

nullable

needId

string format: uuid

nullable

channel

required

Communication channel (sms, email, note).

string

senderIdentifier

required

Sender name or phone identifier.

string

content

Body text of the interaction message or note.

string

nullable

createdAt

required

UTC ISO-8601 timestamp when the record was created.

string format: date-time

Example

{
  "id": "a1b2c3d4-e5f6-7890-abcd-1234567890ab",
  "organizationId": "10000000-0000-0000-0000-000000000001",
  "partnerId": "20000000-0000-0000-0000-000000000002",
  "channel": "sms",
  "senderIdentifier": "Staff - Sarah Jenkins",
  "content": "Scheduled food box pickup for Thursday at 2:00 PM.",
  "createdAt": "2026-07-28T12:00:00Z"
}

400

Bad request

401

Unauthorized

403

Forbidden

404

Need not found