Skip to main content
PATCH
Update subscription notes

Overview

Update the notes field on a subscription. Use this to add internal comments, support ticket references, or any relevant information about the subscription.

Request Fields

Example Request

Response Fields

Common Use Cases

Support Tickets

Reference support interactions and resolutions

Customer Preferences

Record delivery, communication, or service preferences

Internal Notes

Add context for team members handling the account

Issue Tracking

Document known issues or special handling requirements

Example: Append to Existing Notes

Notes are replaced, not appended. To preserve existing notes:

Example: Log Support Interaction

Example: Bulk Update Notes

Notes Best Practices

  • Be concise but include relevant details
  • Use timestamps when logging events
  • Include references (ticket IDs, order numbers)
  • Avoid sensitive data (use separate secure storage for PII)

Error Handling

Authorizations

Authorization
string
header
required

API key obtained from FlexPortal dashboard

Headers

Tenant-ID
string
required

Your tenant identifier

Path Parameters

subscriptionId
string
required

The subscription ID

Body

application/json
notes
string
required
Maximum string length: 5000

Response

Notes updated

success
enum<boolean>
required
Available options:
true
message
string
required
rentalId
string
required