There are scenarios where it can be helpful to create a member's account on their behalf, this can skip the onboarding process and allow new members to log in directly to the community.

This is currently possible through the Heartbeat API (available on our Growth & Business plans).
 

Create a fully active user

Endpoint: https://heartbeat.readme.io/reference/createuser 

This creates a user that skips onboarding and is immediately active in the community.

Required parameters:

• email (string) - Must be unique to the community
• name (string) - The user's full name
• roleID (uuid) - The ID of the role the user should have

Additional, optional parameters are available here.
 

Create a pending user

Endpoint: https://heartbeat.readme.io/reference/creatependinguser 

This creates a new pending user in the community. A pending user does not yet exist within the community and needs to go through onboarding.

Required parameters:

• email (string) - Must be unique to the community
• name (string) - The user's full name
• roleID (uuid) - The ID of the role the user should have

Additional, optional parameters are available here.
 

Authentication

All API requests require an Authorization header with the format:

Bearer <API_KEY>