Set a user's profile photo | Sample

5 body fields

Form data containing the authentication token, image contents, and optional square crop settings.

tokenstringrequired

Authentication token. Requires scope: `users.profile:write`

crop_wstringoptional

Width/height of crop box (always square)

crop_xstringoptional

X coordinate of top-left corner of crop box

crop_ystringoptional

Y coordinate of top-left corner of crop box

imagestringoptional

File contents via `multipart/form-data`.

2 status codes

200Returns `ok` set to true and the updated profile photo URLs and avatar hash in `profile`.

okbooleanrequired

Allowed:true

profileobjectrequired

defaultTypical error response

callstackstringoptional

Note: PHP callstack is only visible in dev/qa

debug_stepstringoptional

possibly DEV/QA only

dimsstringoptional

possibly DEV/QA only

errorstringrequired

Allowed:bad_imagetoo_largetoo_many_framesnot_foundnot_authedinvalid_authaccount_inactivetoken_revokedno_permissionorg_login_requireduser_is_botinvalid_arg_name

okbooleanrequired

Allowed:false

time_identintegeroptional

possibly DEV/QA only

Error handling

token must be included in the form and must carry the users.profile:write scope. Supply image as file contents through multipart form data, and provide crop values as strings when you want to limit the uploaded image to a square region.

import { Client } from "acme-sdk";

const client = new Client({
  baseUrl: "https://api.acme.com",
  retry: {
    maxAttempts: 3,
    retryOn: [
      408,
      425,
      429,
      500,
      502,
      503,
      504,
    ],
    backoffMs: 500,
    maxBackoffMs: 8000,
  },
  timeoutMs: 30000,
});

const result = await client.usersSetPhoto.create({
  token: "sk_live_4eC39Hq",
  cropW: "example",
  cropX: "example",
  cropY: "example",
  image: "example",
});

{
  "ok": true
}

Request

Response

Errors