Site:API:Users

From Metrixstream
Jump to: navigation, search

Contents

Users

Add User

This API call is responsible for creating a user.

Authentication Restrictions

Administrator only.

Required Parameters

  • action=user
  • verb=adduser
  • username: the username of the user

Optional Parameters

  • email
  • commission_pto_percentage
  • commission_ppm_percentage
  • commission_gift_percentage
  • commission_bandwidth_percentage
  • activity_summary_duration_secs

Successful Response

  • status=ok
  • item
    • user
      • id: the id of the user

Edit User

This API call is responsible for editing a user object.

Authentication Restrictions

Any authenticated user.

Required Parameters

  • action=user
  • verb=edituser

Optional Parameters

  • user: the username of the user being updated.
this parameter is only available if the authenticated user is an Administrator.
  • username
  • password
  • email
  • newsletter
  • external_id
  • phone
  • fax
  • dob
  • dob_day
  • dob_month
  • dob_year
  • description
  • display_name
  • display_status
  • lang
  • sex
  • relationship
  • interests
  • activities
  • music
  • tv
  • books
  • location
  • hometown
  • change_username
  • allow_login
  • price_level
  • billing_fname
  • billing_lname
  • billing_company
  • billing_address
  • billing_address2
  • billing_city
  • billing_state
  • billing_zip
  • billing_country
  • billing_email
  • billing_phone
  • billing_fax
  • shipping_fname
  • shipping_lname
  • shipping_company
  • shipping_address
  • shipping_address2
  • shipping_city
  • shipping_state
  • shipping_zip
  • shipping_country
  • shipping_email
  • shipping_phone
  • shipping_fax
  • bank_name
  • bank_address
  • bank_address2
  • bank_city
  • bank_state
  • bank_zip
  • bank_country
  • bank_account
  • bank_routing
  • bank_swift
  • bank_phone
  • bank_iban
  • review
  • status
  • commission_ppm_percentage
  • commission_pto_percentage
  • commission_gift_percentage
  • commission_bandwidth_percentage
  • activity_summary_duration_secs
  • banner,banner1,banner2,banner3,banner4,banner5,banner6,banner7,banner8,banner9,banner10 (multipart)
  • cst_*: custom fields related to this user
replace the * with the appropriate custom field name

Successful Response

  • status=ok
  • properties
    • pending
    • approved
Personal tools