Skip to main content

Update Active User

Description: To update the currently logged in user, a HTTP PUT request is made to the URL with the session token.

Method: PUT

URI: /user/

Parameters:

  • value name: A value in the form.

Headers: Authorization: Third party based authorization header

Returns

FieldTypeDescription
idIntegerUnique ID of the user.
agency_idIntegerUnique ID of the user's agency.
member_numberStringREINSW member number.
realtor_numberStringRegistered land agent number.
given_nameStringFirst name of the user.
surnameStringLast name of the user.
emailStringEmail address of the user.
mobileStringMobile number of the user.
principalBooleanReturns true if user is principal.
default_privateBooleanReturns true if forms created by user are private by default.
activeBooleanReturns true if the user is active.
deletedBooleanReturns true if the user is deleted.
createdTimestampReturns Unix timestamp of when user was created.
updatedTimestampReturns Unix timestamp of when user was last updated.

Example

Request
curl https://app-api.reiformslive.com.au/user \
--request PUT \
--header "content-type: application/json" \
--header "Authorization: Basic YTlkOWIwYItNGY4Yi1hYTQxLTI5NzZmMTcyZmEyMQ==" \
--data '{
"given_name":"Jack"
}'
Response
{
"id": 1,
"agency_id": 1,
"member_number": "1234",
"realtor_number": "1234567",
"given_name": "Jack",
"surname": "Doe",
"email": "JackD@example.com",
"mobile": "",
"principal": true,
"default_private": false,
"active": true,
"deleted": false,
"created": 1354247862,
"updated": 1354765875
}