User Profile

Endpoints:

• Completely update a user
• Partially update a user
• Get user avatar
• Update user avatar
• Delete user avatar
• Get user cover
• Update user cover
• Delete user cover

PUT /users/me

Token: user

Scope: update_profile

Replaces the authenticated user's profile. Anything not included is removed.

Requires a user object with application/json Content-Type.

POST Body Data

Name	Description
locale	Required Valid user locale
timezone	Required Valid user timezone
content.text	256-character string
name	50-character string
raw	Embedded raw values. Not deleted unless explicitly set to empty values for each type

Example

curl "https://api.pnut.io/v1/users/me" \
    -X PUT \
    -H "Authorization: Bearer ${ACCESS_TOKEN}" \
    -H "Content-Type: application/json" \
    -d "{
        \"name\": \"Buddy\",
        \"content\": {
            \"text\": \"Good times and great oldies!\"
        },
        \"timezone\": \"America/Chicago\",
        \"locale\": \"en_US\"
    }" \
    -H "X-Pretty-Json: 1"

Returns the updated user object

{
    "meta": {
        "code": 200
    },
    "data": {
        "...User Object..."
    }
}

PATCH /users/me

Token: user

Scope: update_profile

Updates only specified parts of the authenticated user's profile.

Requires a user object with application/json content type.

POST Body Data

Name	Description
locale	Valid user locale
timezone	Valid user timezone
content.text	256-character string
name	50-character string
raw	Embedded raw values. Not deleted unless explicitly set to empty values for each type

Example

curl "https://api.pnut.io/v1/users/me" \
    -X PATCH \
    -H "Authorization: Bearer ${ACCESS_TOKEN}" \
    -H "Content-Type: application/json" \
    -d "{
        \"timezone\": \"Europe/Paris\",
        \"name\": \"Eric\"
    }" \
    -H "X-Pretty-Json: 1"

Returns the updated user object

{
    "meta": {
        "code": 200
    },
    "data": {
        "....User Object..."
    }
}

GET /users/{user_id}/avatar

Scope: none

This endpoint will return an HTTP 302 redirect to the user’s current avatar image. It will include any query string parameters you pass to the endpoint.

This endpoint is rate limited like the rest of the API and returns a redirect, so if your app has access to the user's current avatar URL, use that instead.

URL Parameters

Name	Description
user_id	ID of the user whose avatar to retrieve

Query String Parameters

Name	Description
h	Optional. The requested height to scale the image down to. Will only scale down from the height of the original avatar. If w is also set, h will be ignored
w	Optional. The requested width to scale the image down to. Will only scale down from the width of the original avatar

Example

curl "https://api.pnut.io/v1/users/@doctorlinguist/avatar" \
    -H "Authorization: Bearer ${ACCESS_TOKEN}" \
    -L

Returns a 302 redirect

POST /users/me/avatar

Token: user

Scope: update_profile

Uploads a new avatar image for the authenticated user.

The uploaded image will be cropped to square, and must be JPEG, PNG, or GIF smaller than 2MiB.

One of the following options must be used:

POST Body Data

Name	Description
avatar	An image included in the POST data with Content-Type of multipart/form-data. Content-Length header must also be set
from_url	A publicly accessible URL of an image to download with Content-Type of application/json

Example

curl "https://api.pnut.io/v1/users/me/avatar" \
    -X POST \
    -H "Authorization: Bearer ${ACCESS_TOKEN}" \
    -F "avatar=@image.png" \
    -H "X-Pretty-Json: 1"

Returns the updated user

{
    "meta": {
        "code": 200
    },
    "data": {
        "...User Object.."
    }
}

DELETE /users/me/avatar

Token: user

Scope: update_profile

This endpoint will delete the existing user avatar (if not already is_default), and revert to their default personalized identicon.

Example

curl "https://api.pnut.io/v1/users/me/avatar" \
    -X DELETE \
    -H "Authorization: Bearer ${ACCESS_TOKEN}" \
    -L

Returns the updated user

{
    "meta": {
        "code": 200
    },
    "data": {
        "....User Object...."
    }
}

GET /users/{user_id}/cover

Scope: none

This endpoint will return an HTTP 302 redirect to the user’s current cover image. It will include any query string parameters you pass to the endpoint.

This endpoint is rate limited like the rest of the API and returns a redirect, so if your app has access to the user's current cover URL, use that instead.

URL Parameters

Name	Description
user_id	ID of the user whose cover image to retrieve

Query String Parameters

Name	Description
h	Optional. The requested height to scale the image down to. Will only scale down from the height of the original avatar. If w is also set, h will be ignored
w	Optional. The requested width to scale the image down to. Will only scale down from the width of the original avatar

Example

curl "https://api.pnut.io/v1/users/12/cover" \
    -H "Authorization: Bearer ${ACCESS_TOKEN}" \
    -L

Returns a 302 redirect

--

POST /users/me/cover

Token: user

Scope: update_profile

Uploads a new cover image for the authenticated user.

The uploaded image must be JPEG, PNG, or GIF, smaller than 4MiB, with a width of at least 960px and height of at least 223px.

If the width / height ratio is less than 2 to 1, the height will be cropped to height / 4.3. A 10000x10000px image would be cropped to 10000x2326px.

One of the following options must be used:

POST Body Data

Name	Description
cover	An image included in the POST data with Content-Type of multipart/form-data. Content-Length header must also be set
from_url	A publicly accessible URL of an image to download with Content-Type of application/json

Example

curl "https://api.pnut.io/v1/users/me/cover" \
    -X POST \
    -H "Authorization: Bearer ${ACCESS_TOKEN}" \
    -F "cover=@image.jpg" \
    -H "X-Pretty-Json: 1"

Returns the updated user

{
    "meta": {
        "code": 200
    },
    "data": {
        "...User Object...."
    }
}

DELETE /users/me/cover

Token: user

Scope: update_profile

This endpoint will delete the existing user cover (if not already is_default), and revert to the default white cover.

Example

curl "https://api.pnut.io/v1/users/me/cover" \
    -X DELETE \
    -H "Authorization: Bearer ${ACCESS_TOKEN}" \
    -L

Returns the updated user

{
    "meta": {
        "code": 200
    },
    "data": {
        "..User Object.."
    }
}