API for delaying user account activation
Managing intricate workflows can be time-consuming, requiring meticulous process design, user creation, task assignment, and thorough testing before granting access. Delayed account activation addresses this challenge by offering administrators the flexibility to design and prepare the whole process within the platform before triggering the activation email for users.
Creating users via the API
When creating a user via the API endpoint POST /api/users/, administrators can now set the delay_activation parameter to true. This ensures that the user remains in the "Created" status without receiving an activation email.
Conversely, setting the parameter to false, or omitting it entirely, triggers the immediate sending of an activation email. The user is then assigned the "Pending" status, indicating that the account activation is pending user confirmation.
The delay_activation parameter is not allowed for 1TC (One-Time Completion) users. When changing the account type from a 1TC user to another type, API users can now send the additional delay_activation parameter via the PATCH /api/users/{user_id} endpoint.
Activation email behavior
Activation emails can now be sent to users in the "Created" or "Pending" statuses. Sending an activation email to a user in the "Created" status automatically changes their status to "Pending."
Only activation emails are allowed to be sent to users in the "Created" and "Pending" statuses. Other system emails, such as those sent by the Send Message actor or task messages, are now blocked for non-active users.
Availability
These changes are currently only available via the API and not on the user interface. This ensures that administrators have full control and visibility over the account activation process, allowing for seamless integration with existing workflows and processes.
Benefits
Delayed account activation empowers Catalyst administrators to plan and configure business processes before activating users. Assigning roles, designating tasks, and thoroughly testing the setup — all without bombarding new users with immediate login prompts. This approach translates to a smoother experience for everyone. Users receive a well-prepared environment, leading to increased satisfaction and accelerated productivity right from the start.