GuidesAPI Reference
Log In
API Reference
  1. Profiles

Update the authenticated user's profile.

patch
https://bonus.ly/api/public/profile

Updates profile fields for the user associated with the bearer token.
All fields are optional — only provided fields are updated.

Avatar changes are subject to the company's avatar uploading policy.
If the company disallows avatar uploads, providing image returns 403.

Requires the user:write scope and a user-scoped token.

Recent Requests
Log in to see full request history
TimeStatusUser Agent
Retrieving recent requests…
LoadingLoading…
Body Params
string
length ≤ 255

Display name override for the user.

string

Avatar image source. Accepts one of:

  • A staged upload file_url from POST /uploads
  • An external HTTPS URL pointing to an image
  • An RFC 2397 data URI (data:image/jpeg;base64,...)

Allowed MIME types: image/jpeg, image/png, image/gif, image/webp.
Maximum file size: 20MB.

boolean
Defaults to false

When true, removes the user's current avatar.
If image is also provided, image takes precedence
and remove_avatar is ignored.

Responses

Updated 2 months ago

Language
Credentials
Bearer
OAuth2 access token
LoadingLoading…
Response
Click Try It! to start a request and see the response here! Or choose an example:
application/json

Updated 2 months ago