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)

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: object (Optional)
    • street: string (Optional)
      Your postal address.
    • city: string (Optional)
      Your postal address.
    • state: string (Optional)
      Your postal address.
    • country: string (Optional)
      Your postal address.
    • zip_code: integer (Optional)
      Your postal address.
  • profile: object (Optional)
    • website: string (Optional)
      Your website address if you have one.
    • short_bio: string (Optional)
      A few words about yourself.
    • avatarURL: string (Optional)
      URL to an avatar image (currently: Gravatar service).
    • profileURL: string (Optional)
      URL to a public profile page shown about you (currently: Gravatar service).
  • settings: object (Optional)
    • location: string (Optional)
      Your location.
    • show_location_flag: boolean (Optional)
      If set, your current location may be shown on your public profile.
    • newsletter_flag: boolean (Optional)
      If enabled, you'll receive the Xvid newsletter.
    • language: string (Optional)
      ISO 639-1 standard are being used. Currently supported values are 'en' and 'de'
    • 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.

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": "johnny",
    "address": {
      "street": "45 Desert Boulevard",
      "city": "Albuquerque",
      "state": "New Mexico",
      "country": "United States",
      "zip_code": 87101 
    },
    "profile": {
      "website": "http://www.acme.com",
      "short_bio": "Blabla",
      "avatarURL": "http://www.gravatar.com/avatar/4589972CB656F09FD314B5ECF865402E",
      "profileURL": "http://www.gravatar.com/4589972CB656F09FD314B5ECF865402E"
    },
    "setting": {
      "location": "Albuquerque",
      "language": "en",
      "time_zone": "America/Chicago",
      "show_location_flag": true,
      "newsletter_flag": false
    }
  }
}'

Example Response ​

Success (200 OK) ​

json
{
  "user": {
    "first_name": "John",
    "last_name": "Doe",
    "email": "jdoe@acme.com",
    "name": "johnny",
    "address": {
      "street": "45 Desert Boulevard",
      "city": "Albuquerque",
      "state": "New Mexico",
      "country": "United States",
      "zip_code": 87101
    },
    "profile": {
      "website": "http://www.acme.com",
      "short_bio": "Blabla",
      "avatarURL": "http://www.gravatar.com/avatar/4589972CB656F09FD314B5ECF865402E",
      "profileURL": "http://www.gravatar.com/4589972CB656F09FD314B5ECF865402E"
    },
    "setting": {
      "location": "Albuquerque",
      "language": "en",
      "time_zone": "America/Denver",
      "show_location_flag": true,
      "newsletter_flag": false
    },
    "id": "5470c6b5e4b09edbcfd16235",
    "href": "https://api.xvid.com/v1/users/5470c6b5e4b09edbcfd16235"
  }
}

Error Responses ​

400 Bad Request ​

json
{
  "error": {
    "error_code": "0x0010001",
    "error_message": "Invalid Input"
  }
}

403 Forbidden ​

json
{
  "error": {
    "error_code": "0x0000003",
    "error_message": "Invalid access token"
  }
}

500 Internal Server Error ​

json
{
  "error": {
    "error_code": "0x0000001",
    "error_message": "Internal Error"
  }
}