User.modify: Difference between revisions

From Safe Creative API
Jump to navigation Jump to search
w>Jguillo
No edit summary
w>Jguillo
No edit summary
Line 32: Line 32:


* '''restvalueresponse'''
* '''restvalueresponse'''
** '''state''' ready
** '''state''': ready


= Example =
= Example =

Revision as of 11:06, 19 January 2011

Partner component to modify a user account. User account must have been created with user.link.

You must be a Safe Creative partner to use this component.

Info

  • Component name: user.modify
  • Signature: Requires signature using the authorization key's private key
  • Timestamp: Requires ztime parameter
  • Authorization level: MANAGE
  • API trust level: Partner

Parameters

  • authkey*: Authorization key
  • ztime*: Z-Timestamp
  • mail: user mail
  • firstName: first name of the user
  • middleName: middle name of the user
  • lastName: last name of the user
  • addressLine1: user address line 1
  • addressLine2: user address line 2
  • addressZip: user address zip code
  • addressCity: user address zip city
  • addressCountry: user address country code (see user.countries)
  • sendNotifications: 1 if user wants to be sent daily notifications of his operations. 0 if user does not want notifications.
  • locale: user preferred locale

* Required parameter

Returns

  • restvalueresponse
    • state: ready

Example

REQUEST:

https://api.safecreative.org/v2/
?component=user.link
&sharedkey=zy9x4ol0ctg3btyswq7b5wi9
&level=MANAGE
&mail=sholmes%40baker.fake
&firstname=Sherlock
&lastname=Holmes
&addressline1=221B+Baker+Street
&addressline2=City+of+Westminster
&addresscity=London
&addresscountry=GB
&locale=en
&ztime=1271749826106
&signature=3b2d5552b5cd969c370ce70dae280a76dc844895

RESPONSE:

<?xml version="1.0" encoding="UTF-8"?>
<restvalueresponse>
  <state>ready</state>
</restvalueresponse>