Skip to main content

Create User

Description: To create a user, a HTTP POST request is made to the URL with the user ID and session token.

Method: POST

URI: /users/

Required Parameters:

  • given_name: The first name of the user.

  • surname: The last name of the user.

  • email: The email of the user.

Additional Parameters:

  • member_number: The member number of the user.

  • realtor_number: The realtor number of the user.

  • mobile: The mobile number of the user.

Headers: Authorization: Third party based authorization header

Returns

FieldTypeDescription
MessageStringMessage relating to the update.

Example

Request
curl https://app-api.reiformslive.com.au/users \
--request POST \
--header "content-type: application/json" \
--header "Authorization: Basic YTlkOWIwYItNGY4Yi1hYTQxLTI5NzZmMTcyZmEyMQ==" \
--data '{
"given_name":"Jack",
"surname":"Doe",
"email":"jackd@example.com"
}'
Response
{
"message": "The user account was successfully created."
}