Profile Picture From Sign-In

PUT /v1/user/avatar/settings

Choose whether a Google, GitHub or company sign-in sets your profile picture. It is on by default.

  • true: the next sign-in that brings a picture sets it (a picture you uploaded stays).
  • false: sign-ins never set it, and a picture a sign-in set is removed. A picture you uploaded stays.

Request body

from_signin boolean Req
true or false.

Response (200 OK)

avatar_version string
The version of your picture now; "" when you have none.
avatar_source string
google, github, oidc, upload, or "" when you have none.
avatar_from_signin boolean
Whether a sign-in that brings a picture sets yours.

Errors

400 Bad Request
from_signin is missing or not a boolean, or the body has other fields.
401 Unauthorized
Missing or invalid auth.
429 Too Many Requests
You changed your picture many times in a short time. Try again in a minute.
503 Service Unavailable
Pictures can't be changed right now. Try again shortly.
Request
curl -X PUT "https://api.ngris.com/v1/user/avatar/settings" \ -H "X-API-KEY: <your_api_key>" \ -H "Content-Type: application/json" \ -d '{ "from_signin": false }'
Response
{ "avatar_version": "", "avatar_source": "", "avatar_from_signin": false }
Was this helpful?
Was this helpful?