Update current user

PUT

/users/me

users

Update the current user. All fields are optional so requests can update just one or multiple user properties at a time.

Request Example

Shell

JavaScript

Java

Swift

curl --location --request PUT 'https://trashnothing.com/api/v1.2/users/me'

Response Example

200 - Example 1

{
    "about_me": "I used to be an accountant but then I decided to become a pirate.",
    "country": "US",
    "digest": "6_hours",
    "digest_photos": false,
    "email": {
        "address": "johndoe@example.com",
        "bouncing": false,
        "spam_stop": false,
        "verified": true
    },
    "firstname": "Jack",
    "has_password": false,
    "last_listings_view": "2018-02-15T15:04:47",
    "lastname": "Carter",
    "location": {
        "latitude": 39.766098,
        "longitude": -105.077206,
        "name": "Wheat Ridge, CO, USA",
        "radius'": 32186.88
    },
    "member_since": "2009-09-25T14:20:01",
    "post_location": {
        "latitude": 39.766098,
        "longitude": -105.077206,
        "name": "Wheat Ridge"
    },
    "post_reminders": true,
    "profile_image": "https://gravatar.com/avatar/88305a95b05b30f6cd306019ea5d88f3?s=90&r=pg&default=identicon",
    "profile_image_source": "gravatar",
    "public_name": false,
    "public_post_sources": [
        "trashnothing"
    ],
    "show_all_group_posts": true,
    "signup": "2017-11-20T04:32:06",
    "special_notices": true,
    "user_id": 119458,
    "username": "captainjack",
    "uses_fair_offer_policy": true,
    "verified": true
}

Request

Body Params multipart/form-data

about_me

string

optional

A short bio a user has written about themselves to help other members get to know them better.

digest

string

optional

The frequency of digest emails sent to this user. One of: weekly, twice_weekly, daily, 12_hours, 8_hours, 6_hours, 4_hours, 2_hours, hourly

To disable digests, set this to an empty string.

digest_photos

string

optional

Whether or not to include photos in the digest emails. Set to 1 to enable photos and 0 to disable photos.

firstname

string

optional

The first name of the user.

last_listings_view

string

optional

The UTC date and time when the user last viewed the newest posts on the All Posts page.

lastname

string

optional

The last name of the user.

old_password

string

optional

The users current password. This is required when the user is changing their password.

password

string

optional

A new password for the users' account. When setting a new password, the old_password parameter must be passed and set to the users' current password.

NOTE: The password and old_password properties can NOT be used when the user property has_password is false. Instead, use the password reset endpoint to have a new password emailed to the user.

post_reminders

string

optional

Whether or not the user will receive post reminder emails (to remind them to update or repost their posts). Set to 1 to enable and 0 to disable.

profile_image_source

string

optional

The source of the users' profile image. The values this can be set to change dynamically based on the users' account. To get the values that can be used, use the source properties returned by the profile images endpoint.

public_name

string

optional

Whether or not the users' first and last name will be visible to other users. Set to 1 to enable and 0 to disable.

public_post_sources

string

optional

A comma separated list of the sources to show public posts from. Currently only 'trashnothing' is supported.
If not passed, all sources will be enabled.
If set to an empty string, no sources will be enabled which effectively disables public posts for the user so that the user will only see posts from the groups they are a member of. Setting to an empty string is only allowed if the user is a member of one or more groups.

show_all_group_posts

string

optional

Set to 1 to show all group posts on the main posts page and in the digest emails. Set to 0 to only show group posts in the area defined by the users' location. Can only be set to 0 if the users' location is already set.

special_notices

string

optional

Whether or not the user wants to receive special notice emails from the groups they are a member of. Special notices are admin posts that the group moderators choose to send out by email. Set to 1 to enable and 0 to disable.

Responses

🟢200The updated user data.

application/json

Body

about_me

string

optional

A short bio a user has written about themselves to help other members get to know them better. May be null if the user has not written anything about themselves.

country

string

optional

A 2 letter country code for the country that has been automatically detected for the user (see https://en.wikipedia.org/wiki/ISO_3166-1_alpha-2 ). May be null if no country has been set.

feedback

object

optional

percent_positive

number

optional

The percent of feedback that this user has received in the last year that was positive. May be null if a user has not received enough feedback to calculate a percentage.

>= 0<= 100

restriction

string

optional

If the current user can leave positive or negative feedback on this user then restriction is null.

Otherwise, restriction is set to a string that explains why feedback is currently restricted and what type of feedback is restricted. The string will be one of the following: no-recent-messages, negative-score, moderator, [days]-day-wait-for-negative

- no-recent-messages: The current user has not received any messages from this user in the last 30 days.
- negative-score: The current user has a negative feedback and will not be able to leave feedback until their score is >= 0.
- moderator: The user is a moderator and leaving feedback on moderators is not currently supported.
- [days]-day-wait-for-negative: Positive feedback is not restricted but the current user must wait
some number of days before they will be able to leave negative feedback on this user. This string can
change depending on the number of days. For example, when the current user must wait one day, the
string will be '1-day-wait-for-negative'. A wait is necessary because a lot of negative feedback results
from communication issues that are resolved with more time.

score

integer

optional

The feedback score of this user. Higher scores are better. Scores are calculated by substracting the total number of negative feedback from the total number of positive feedback that a user has received. May be null if a user has not received enough feedback to calculate a score.

firstname

string

optional

The first name of the user (may be null).

lastname

string

optional

The last name of the user (may be null).

member_since

string

optional

The date and time when the user first became publicly active on a group (the date may be older than when the user signed up).

profile_image

string

optional

A URL to a profile image for the user. Profile images sizes vary based on the source (Google, Facebook, Gravatar, etc) and some can be as small as 64px by 64px. Will be null for api key requests and requests where the oauth user doesn't belong to any of the same groups as this user.

reply_time

integer

optional

An estimate of how many seconds it takes this user to reply to messages. May be null when there is not enough data to calculate an estimate.

user_id

string

optional

username

string

optional

A username that can be displayed for the user (the username is NOT guaranteed to be unique). Will be null for api key requests and requests where the oauth user doesn't belong to any of the same groups as this user.

digest

string

optional

If digest emails are enabled, this is the frequency of digest emails sent to this user. One of: weekly, twice_weekly, daily, 12_hours, 8_hours, 6_hours, 4_hours, 2_hours, hourly

If digest emails are disabled, this will be null.

digest_photos

boolean

optional

Whether or not photos are included in the digest emails sent to the user.

object

optional

Data related to the users' email address.

address

string

optional

The email address.

bouncing

boolean

optional

Whether or not this email address has been bouncing emails that are sent to it. When bouncing is true, no emails will be sent to the user. If the user thinks that their email account shouldn't be bouncing emails, use the email not bouncing endpoint to reset bouncing to false.

spam_stop

boolean

optional

Whether or not emails have been stopped because of a spam complaint from the users' email account. When spam_stop is first set to true, it indicates that all emails have been automatically disabled for the users' account (eg. digest and alerts). The user will need to re-enable digests and re-add any alerts that they had previously set up.

has_password

boolean

optional

Whether or not the user has a password (accounts created using 3rd party providers like Facebook don't have passwords set).

When has_password is false, the only way to set a password on the users' account is to send the user a password reset email.

last_listings_view

string <date-time>

optional

The UTC date and time when the user last viewed the newest posts on the All Posts page (may be null).

NOTE: For this to be accurate, clients must update the last_listings_view property of the current user every time the user is shown the newest posts on the All Posts page.

location

object

optional

The users' location. The location is used to determine which posts are shown to the user (may be null).

latitude

number

optional

longitude

number

optional

name

string

optional

A text description of the location specified by latitude and longitude.

radius

number

optional

Defines the radius (in meters) of a circle around the point specified by latitude and longitude.

>= 0<= 257500

post_location

object

optional

Location data used by the user the last time they posted.

latitude

number

optional

May be null.

longitude

number

optional

May be null.

name

string

optional

A text description of the location specified by latitude and longitude.

post_reminders

boolean

optional

Whether or not post reminders are enabled for this user (to remind them to update or repost their posts).

profile_image_source

string

optional

The source of the users' profile image. One of: gravatar, facebook, google, freegle, custom

public_name

boolean

optional

Whether or not the user has chosen to make their first and last name public.

public_post_sources

array[string]

optional

A list of the public post sources the user is interested in seeing posts from (currently only 'trashnothing' is supported). If the array is empty, no sources are enabled and the user will only see posts from the groups they are a member of.

NOTE: Additional sources may be added in the future so clients should take care to support arbitrary sources being returned.

show_all_group_posts

boolean

optional

If true, all group posts from the users' groups are shown to them on the main posts page and in the digest emails.

If false, only group posts in the area defined by the users' location are shown.

signup

string <date-time>

optional

The UTC date and time when the user signed up.

special_notices

boolean

optional

Whether or not the user wants to receive special notice emails from the groups they are a member of. Special notices are admin posts that the group moderators choose to send out by email.

uses_fair_offer_policy

boolean

optional

Whether or not the user used the Fair Offer Policy (see https://trashnothing.com/fair_offer_policy ) the last time they posted.

verified

boolean

optional

Whether or not the user has verified their account. The user account will be limited (eg. they will not be able to reply to posts) until their account is verified.

🟠400Invalid parameter.

Modified at 2022-09-11 18:59:48

Retrieve current user

List current users' email alerts