Update current user's preferences
Header Parameters
X-API-Keystring
Authorizationstring
Body Parameters
schemaVersioninteger Required
The schema version these preferences conform to
prefsobject Required
Simple customer preference values organized by section (used for updates)
Response
200
Object
Preferences updated successfully
Response Attributes
schemaVersioninteger Required
The schema version these preferences conform to
prefsobject Required
Customer preference values with schema metadata organized by section
updatedAtstring
When the preferences were last updated
201
Object
Preferences created successfully
Response Attributes
schemaVersioninteger Required
The schema version these preferences conform to
prefsobject Required
Customer preference values with schema metadata organized by section
updatedAtstring
When the preferences were last updated
400
Object
Bad request - Invalid preferences format
Response Attributes
errorsstring Required
Error code identifying the type of error
Enum values:
bad_requestunauthorizedforbiddennot_found500incorrect_datanot_memberalready_memberincorrect_stripe_signatureincorrect_stripe_event... 4 other enums
401
Object
Unauthorized - Invalid API key or JWT
Response Attributes
messagestring
Error message
codestring
Error code
detailsobject
Additional error details
409
Object
Conflict - Schema version mismatch
Response Attributes
errorsstring Required
Error code identifying the type of error
Enum values:
bad_requestunauthorizedforbiddennot_found500incorrect_datanot_memberalready_memberincorrect_stripe_signatureincorrect_stripe_event... 4 other enums
Was this section helpful?
What made this section unhelpful for you?
Response
Was this section helpful?
What made this section unhelpful for you?