API Documentation

Appearance

PUT /users/ID ​

Description ​

Update your user account details.

Authentication ​

  • Required: Yes
  • Method: Bearer token

Request Headers ​

  • Authorization: Bearer [AUTH_TOKEN]
  • Accept:
    • application/json (for JSON responses)
    • application/xml (for XML responses)

Parameters ​

Query Parameters ​

  • format: string (Optional)
    Values: json, xml
    Overrides the Request Accept header.
  • human: boolean (Optional)
    Values: true, false
    Causes the response to be in a structured, more human-readable form.
  • show_null: boolean (Optional)
    Values: true, false
    If set to "true", the response will contain keys that are not set to a value.

Body Parameters ​

  • user: object (Required)
    • first_name: string (Optional)
    • last_name: string (Optional)
    • email: string (Optional)
    • name: string (Optional)
    • address: object (Optional)
      • street: string (Optional)
      • city: string (Optional)
      • state: string (Optional)
      • country: string (Optional)
      • zip_code: integer (Optional)
    • profile: object (Optional)
      • website: string (Optional)
      • short_bio: string (Optional)
      • avatarURL: string (Optional)
      • profileURL: string (Optional)
    • setting: object (Optional)
      • location: string (Optional)
      • language: string (Optional)
        Values: ISO 639-1 standard (e.g., 'en', 'de')
      • time_zone: string (Optional)
        Values: Valid IANA timezone strings
      • show_location_flag: boolean (Optional)
      • newsletter_flag: boolean (Optional)

Example Request ​

bash
curl -X PUT "https://api.xvid.com/v1/users/5470c6b5e4b09edbcfd16235?human=true" \
  -H "Authorization: Bearer AUTH_TOKEN" \
  -H "Content-Type: application/json" \
  -d '{
    "user": {
      "first_name": "John",
      "last_name": "Doe",
      "email": "jdoe@acme.com",
      "name": "johnny22",
      "address": {
        "street": "Franklin Ave 100",
        "city": "Chicago",
        "state": "Illinois",
        "country": "USA",
        "zip_code": 14944
      },
      "profile": {
        "website": "http://www.acme.com",
        "short_bio": "Blabla",
        "avatarURL": "http://www.gravatar.com/avatar/4589972CB656F09FD314B5ECF865402E",
        "profileURL": "http://www.gravatar.com/4589972CB656F09FD314B5ECF865402E"
      },
      "setting": {
        "location": "Chicago",
        "language": "en",
        "time_zone": "America/Chicago",
        "show_location_flag": false,
        "newsletter_flag": true
      }
    }
  }'

Valid Fields ​

  • first_name: string (Optional)
    Your first name (real name).
  • last_name: string (Optional)
    Your last name (real name).
  • name: string (Optional)
    Your screen name or username.
  • email: string (Optional)
    Your email address.
  • address:street: string (Optional)
    Your postal address.
  • address:city: string (Optional)
    Your postal address.
  • address:state: string (Optional)
    Your postal address.
  • address:country: string (Optional)
    Your postal address.
  • address:zip_code: integer (Optional)
    Your postal address.
  • profile:website: string (Optional)
    Your website address if you have one.
  • profile:short_bio: string (Optional)
    A few words about yourself.
  • profile:avatarURL: string (Optional)
    URL to an avatar image (currently: Gravatar service).
  • profile:profileURL: string (Optional)
    URL to a public profile page shown about you (currently: Gravatar service).
  • settings:location: string (Optional)
    Your location.
  • settings:show_location_flag: boolean (Optional)
    If set, your current location may be shown on your public profile.
  • settings:newsletter_flag: boolean (Optional)
    If enabled, you'll receive the Xvid newsletter.
  • settings:language: string (Optional)
    ISO 639-1 standard are being used. Currently supported values are 'en' and 'de'
  • settings:time_zone: string (Optional)
    Supported values are all valid IANA timezone strings

Note: All fields are optional. Fields that are not included in the PUT request will not be updated. If you want to delete/reset a field, set it to "null" specifically.