Endpoint
Authentication
This endpoint requires authentication via bearer token representing a valid user session managed by Supabase Auth (cookies).Testing Note: Due to the requirement for a live user session, this endpoint cannot be successfully tested directly using the ‘Send’ button in this documentation with a static token.To test:
- Call this endpoint from your web application after logging in.
- Use
curl
or a similar tool with a valid, current user JWT obtained from your browser’s session after logging in.
curl
, you need the JWT access token stored by Supabase Auth in your browser.
- Log in to your application normally in your browser.
- Open Developer Tools (usually F12).
- Go to the Application tab (it might be called Storage in Firefox).
- Under the Storage section, find Cookies and select your application’s domain (e.g.,
http://localhost:3000
orhttps://onlyautomator.com
). - Look for a cookie named similar to
sb-access-token
(the exact name might vary slightly based on Supabase configuration). - Copy the entire value of this cookie. This is your Bearer token.
- Use this copied value in the
Authorization: Bearer <your_copied_token>
header for yourcurl
or other API tool requests.
Request Headers
Bearer token for authentication. Format:
Bearer YOUR_JWT_TOKEN
Must be set to
application/json
Request Body
Unique identifier of the subscriber/fan
Content of the note
Type of note. Can be one of: “personal”, “preferences”, “payment”, “content”, or “other”. Default: “personal”
Color code for the note (for visual categorization). Format: “#RRGGBB”
Whether the note should be pinned to the top. Default: false
Response
Status of the request (
success
or error
)Note object that was created or updated
Unique identifier for the note
Unique identifier of the subscriber/fan
Content of the note
Type of the note
Color code for the note
Whether the note is pinned
ISO timestamp of when the note was created
ISO timestamp of when the note was last updated
200 Success
400 Bad Request
401 Unauthorized
403 Forbidden
404 Not Found
Error Codes
Error Code | Description |
---|---|
validation_error | A required parameter is missing or invalid |
authentication_required | No valid authentication token provided |
permission_denied | Token lacks required permissions |
resource_not_found | Fan not found with the provided ID |
service_unavailable | The note service is temporarily unavailable |
Notes
- This endpoint is used by the CRM panel in the Chrome extension to add or update notes about subscribers
- Notes are synchronized with the OnlyAutomator database and can be viewed both in the extension and on the web dashboard
- If a note with the same
fanId
andtype
already exists, it will be updated instead of creating a new note - The maximum length for the
content
field is 2000 characters
Authorizations
Bearer authentication header of the form Bearer <token>
, where <token>
is your auth token.
Headers
Bearer token for authentication (JWT)
Body
application/json
Unique identifier of the subscriber/fan
Example:
"12345"
Content of the note
Example:
"Subscriber likes fitness content and usually tips on workout videos."
Type of note
Available options:
personal
, preferences
, payment
, content
, other
Example:
"personal"
Color code for the note (for visual categorization)
Example:
"#3498db"
Whether the note should be pinned to the top
Example:
false