Activate Users

Reactivate up to 50 previously deactivated users, identified by email address. Activation is subject to the account's user license limit.

PUT

/api/public/users/activate

Headers

Key	Value
Content-Type	application/json
Authorization	Bearer <Account API Key>

Request body

Field	Type	Description
list_user_email (required)	Array of String	Email addresses of the users to activate. Only the first 50 entries are processed.

{
    "list_user_email": ["jane@example.com", "john@example.com"]
}

Example cURL

curl --location --request PUT '<BUILDER_URL>/api/public/users/activate' \
--header 'Content-Type: application/json' \
--header 'Authorization: Bearer XXXXXXXXXXXXXXXXXXXXXXXXX' \
--data-raw '{
    "list_user_email": ["jane@example.com", "john@example.com"]
}'

Responses

Status Code	Description	Response
200	Request processed. The body groups the supplied emails by outcome.	application/json
400	list_user_email is empty	application/json
401	Unauthorized	application/json
500	Internal Server Error	application/json

Response fields

Field	Type	Description
users_success	Array of String	Emails of users that were activated.
users_invalid	Array of String	Entries that are not valid email addresses.
users_not_exist	Array of String	Valid emails that do not belong to any user in this account.
users_failed	Array of String	Users for whom activation failed.

Sample response

200 : Success

{
    "users_success": ["jane@example.com"],
    "users_invalid": ["not-an-email"],
    "users_failed": [],
    "users_not_exist": ["ghost@example.com"]
}