FxHubPartnersApi

<back to all web services

UpdateUser

Requires Authentication
The following routes are available for this service:
PUT/users/update
UpdateUser Parameters:
NameParameterData TypeRequiredDescription
EmailbodystringNo
PartnerIdsbodyList<int>No
UserbodyCustomUserAuthNo
CustomUserAuth Parameters:
NameParameterData TypeRequiredDescription
PartnerIdsformList<int>No
PartnerNamesformList<string>No
PartnerIdformintNo
PartnerNameformstringNo
DefaultProfileUrlformstringNo
SignatureformstringNo
SignatureUrlformstringNo
IpAddressformstringNo
RefSourceformstringNo
RefUrnformstringNo
BannedformDateTime?No
BannedByformstringNo
NotesformstringNo
DisableEmailsformDateTime?No
CreatedByformstringNo
HasMultipleLoginsformstringNo
UserAuth Parameters:
NameParameterData TypeRequiredDescription
IdformintNo
UserNameformstringNo
EmailformstringNo
PrimaryEmailformstringNo
PhoneNumberformstringNo
FirstNameformstringNo
LastNameformstringNo
DisplayNameformstringNo
CompanyformstringNo
BirthDateformDateTime?No
BirthDateRawformstringNo
AddressformstringNo
Address2formstringNo
CityformstringNo
StateformstringNo
CountryformstringNo
CultureformstringNo
FullNameformstringNo
GenderformstringNo
LanguageformstringNo
MailAddressformstringNo
NicknameformstringNo
PostalCodeformstringNo
TimeZoneformstringNo
SaltformstringNo
PasswordHashformstringNo
DigestHa1HashformstringNo
RolesformList<string>No
PermissionsformList<string>No
CreatedDateformDateTimeNo
ModifiedDateformDateTimeNo
InvalidLoginAttemptsformintNo
LastLoginAttemptformDateTime?No
LockedDateformDateTime?No
RecoveryTokenformstringNo
RefIdformint?No
RefIdStrformstringNo
MetaformDictionary<string, string>No
UpdateUserResponse Parameters:
NameParameterData TypeRequiredDescription
ResultformboolNo
MessageformstringNo

To override the Content-type in your clients, use the HTTP Accept Header, append the .jsv suffix or ?format=jsv

HTTP + JSV

The following are sample HTTP requests and responses. The placeholders shown need to be replaced with actual values.

PUT /users/update HTTP/1.1 
Host: api.fxlink.co.za 
Accept: text/jsv
Content-Type: text/jsv
Content-Length: length

{
	email: String,
	partnerIds: 
	[
		0
	],
	user: 
	{
		partnerIds: 
		[
			0
		],
		partnerNames: 
		[
			String
		],
		partnerId: 0,
		partnerName: String,
		defaultProfileUrl: String,
		signature: String,
		signatureUrl: String,
		ipAddress: String,
		refSource: String,
		refUrn: String,
		banned: 0001-01-01,
		bannedBy: String,
		notes: String,
		disableEmails: 0001-01-01,
		createdBy: String,
		hasMultipleLogins: String,
		id: 0,
		userName: String,
		email: String,
		primaryEmail: String,
		phoneNumber: String,
		firstName: String,
		lastName: String,
		displayName: String,
		company: String,
		birthDate: 0001-01-01,
		birthDateRaw: String,
		address: String,
		address2: String,
		city: String,
		state: String,
		country: String,
		culture: String,
		fullName: String,
		gender: String,
		language: String,
		mailAddress: String,
		nickname: String,
		postalCode: String,
		timeZone: String,
		salt: String,
		passwordHash: String,
		digestHa1Hash: String,
		roles: 
		[
			String
		],
		permissions: 
		[
			String
		],
		createdDate: 0001-01-01,
		modifiedDate: 0001-01-01,
		invalidLoginAttempts: 0,
		lastLoginAttempt: 0001-01-01,
		lockedDate: 0001-01-01,
		recoveryToken: String,
		refId: 0,
		refIdStr: String,
		meta: 
		{
			String: String
		}
	}
}
HTTP/1.1 200 OK
Content-Type: text/jsv
Content-Length: length

{
	result: False,
	message: String
}