Skip to main content
POST
/
api
/
v2
/
update-preference
Update Preference
curl --request POST \
  --url https://onlyautomator.com/api/v2/update-preference \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "fanId": "12345",
  "category": "content",
  "preference": "likes_fitness_videos",
  "value": true
}
'
{
  "status": "success",
  "data": {
    "id": "pref_1c2d3e4f-5678-9012-ijkl-456789abcdef",
    "fanId": "12345",
    "category": "content",
    "preference": "likes_fitness_videos",
    "value": true,
    "createdAt": "2023-03-15T14:23:45Z",
    "updatedAt": "2023-03-15T14:23:45Z"
  }
}
Updates or creates preference information for a subscriber in the OnlyAutomator CRM system.

​
Endpoint

POST /api/v2/update-preference

​
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:
  1. Call this endpoint from your web application after logging in.
  2. Use curl or a similar tool with a valid, current user JWT obtained from your browser’s session after logging in.
Retrieving JWT Token for Testing: To test endpoints requiring a user session with tools like curl, you need the JWT access token stored by Supabase Auth in your browser.
  1. Log in to your application normally in your browser.
  2. Open Developer Tools (usually F12).
  3. Go to the Application tab (it might be called Storage in Firefox).
  4. Under the Storage section, find Cookies and select your application’s domain (e.g., http://localhost:3000 or https://onlyautomator.com).
  5. Look for a cookie named similar to sb-access-token (the exact name might vary slightly based on Supabase configuration).
  6. Copy the entire value of this cookie. This is your Bearer token.
  7. Use this copied value in the Authorization: Bearer <your_copied_token> header for your curl or other API tool requests.
Note: This token has a limited lifetime and you’ll need to copy a fresh one after it expires. 
# Available URLs:
# - Local development: http://localhost:3000/api/v2/update-preference
# - Production: https://onlyautomator.com/api/v2/update-preference

# Example with curl:
curl -X POST "https://onlyautomator.com/api/v2/update-preference" \
  -H "Authorization: Bearer YOUR_JWT_TOKEN" \
  -H "Content-Type: application/json" \
  -d '{
    "fanId": "12345",
    "category": "content",
    "preference": "likes_fitness_videos",
    "value": true
  }'

​
Request Headers

​
Authorization
string
required
Bearer token for authentication. Format: Bearer YOUR_JWT_TOKEN
​
Content-Type
string
required
Must be set to application/json

​
Request Body

​
fanId
string
required
Unique identifier of the subscriber/fan
​
category
string
required
Category of the preference. Common values: “content”, “messaging”, “tipping”, “scheduling”
​
preference
string
required
Specific preference identifier. Should be a descriptive string without spaces
​
value
any
required
Value of the preference. Can be a boolean, string, number, or any JSON-serializable value

​
Response

​
status
string
Status of the request (success or error)
​
data
object
Preference object that was created or updated
​
data.id
string
Unique identifier for the preference record (UUID).
​
data.fanId
string
Unique identifier of the subscriber/fan this preference belongs to.
​
data.userId
string
Unique identifier of the OnlyAutomator user who created/updated this preference.
​
data.category
string
Category of the preference (e.g., “content”, “messaging”).
​
data.preference
string
Specific preference identifier or key (e.g., “likes_fitness_videos”).
​
data.value
any
Value of the preference (can be boolean, string, number, etc.).
​
data.source
string
Source of the preference (e.g., “manual”, “extension”, “inferred”, nullable).
​
data.createdAt
string
ISO timestamp of when the preference record was created.
​
data.updatedAt
string
ISO timestamp of when the preference record was last updated.

​
200 Success

{
  "status": "success",
  "data": {
    "id": "pref_uuid_1c2d3e4f",
    "fanId": "fan_uuid_12345",
    "userId": "user_uuid_abcdef",
    "category": "content",
    "preference": "likes_fitness_videos",
    "value": true,
    "source": "extension",
    "createdAt": "2023-03-15T14:23:45Z",
    "updatedAt": "2023-03-15T14:23:45Z"
  }
}

​
400 Bad Request

{
  "status": "error",
  "error": {
    "code": "validation_error",
    "message": "The 'category' field is required"
  }
}

​
401 Unauthorized

{
  "status": "error",
  "error": {
    "code": "authentication_required",
    "message": "Authentication is required to access this resource"
  }
}

​
403 Forbidden

{
  "status": "error",
  "error": {
    "code": "permission_denied",
    "message": "Your token does not have permission to access this resource"
  }
}

​
404 Not Found

{
  "status": "error",
  "error": {
    "code": "resource_not_found",
    "message": "Fan not found with the provided ID"
  }
}

​
Error Codes

Error CodeDescription
validation_errorA required parameter is missing or invalid
authentication_requiredNo valid authentication token provided
permission_deniedToken lacks required permissions
resource_not_foundFan not found with the provided ID
service_unavailableThe preference service is temporarily unavailable

​
Common Preference Categories

CategoryDescriptionExample Preferences
contentContent preferenceslikes_fitness, prefers_photos, enjoys_long_videos
messagingMessaging preferencesprefers_voice_messages, responds_to_text, morning_messages
tippingTipping behaviorfrequent_tipper, high_value_tipper, special_occasion_tipper
schedulingTiming preferencesactive_weekends, evening_chatter, timezone_gmt_minus_8

​
Notes

  1. This endpoint is used by the CRM panel in the Chrome extension to track subscriber preferences
  2. Preferences help creators customize their content and interactions for each subscriber
  3. If a preference with the same fanId, category, and preference already exists, it will be updated
  4. The system supports custom preference categories and names beyond the common ones listed above

Authorizations

​
Authorization
string
header
required

Standard user JWT token for authentication.

Headers

​
Authorization
string
required

Bearer token for authentication (JWT)

Body

application/json
​
fanId
string
required

Unique identifier of the subscriber/fan

Example:

"12345"

​
category
string
required

Category of the preference

Example:

"content"

​
preference
string
required

Specific preference identifier

Example:

"likes_fitness_videos"

​
value
object
required

Value of the preference (can be any JSON type: boolean, string, number, object, array).

Example:

true

Response

Preference created or updated successfully

​
status
string
Example:

"success"

​
data
object