User Update

Customers and distributor's staff can update users' details through ActivePlatform. The User Update notification URL allows the vendor service to receive notifications when user details were changed.

The general flow for the User Update event includes the following steps:

User details are changed via ActivePlatform.
ActivePlatform calls the configured notification URL, passing the JSON with user details.
The vendor service validates the request, updates the user, returns the user ID or provides details about the occurred error.
ActivePlatform updates the user.

POST /user/update?ap_guid={ap_guid}&reseller_id={reseller_id}

Arguments

Name	Parameter type	Data type	Description
ap_guid	query	string	Auto-generated installation GUID (Globally Unique Identifier). The ap_guid is used to identify the ActivePlatform installation that called the entry point
reseller_id	query	string	Reseller ID who sold the subscription of the service plan through the ActivePlatform installation

Event body

Name	Data type	Description
id	string	User ID generated in the vendor service
first_name	string	First name for the user
last_name	string	Last name for the user

Response

If a user was successfully updated, the vendor service returns:

200 HTTP code status.

If a user was not updated, the vendor service returns:

HTTP code status.
JSON with the following information:

Name		Data type	Description
task		object
	error_message	string	Text message of the occurred error

Event example

POST http://example.com/user/update

{
	"id":"1234567",
	"first_name":"John",
	"last_name":"Doe"
}

Response example

HTTP code: 200 OK