Delete the authenticated user's profile photo

1 body field

Form data containing the authentication credential required to delete the authenticated user's profile photo.

tokenstringrequired

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

2 status codes

200Confirms that the authenticated user's profile photo was deleted.

okbooleanrequired

Allowed:true

defaultTypical error response

callstackstringoptional

Note: PHP callstack is only visible in dev/qa

errorstringrequired

Allowed:not_authedinvalid_authaccount_inactivetoken_revokedno_permissionorg_login_requireduser_is_botinvalid_arg_nameinvalid_array_arginvalid_charsetinvalid_form_datainvalid_post_type

okbooleanrequired

Allowed:false

Error handling

token is required and must have the users.profile:write scope. Submit the form body using the expected form-encoded format and provide a valid authentication token.

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.usersDeletePhoto.create({ token: "sk_live_4eC39Hq" });

{
  "ok": true
}

Request

Response

Errors