Skip to content

Create Out-of-Band Code

Generate an out-of-band (OOB) code for a user, such as an email verification or password reset link. Requires ADMIN permissions and the PEOPLE_MANAGEMENT feature flag.

Parameters

name * are required parametersdata typedescription
userId*stringThe unique identifier of the user
body.type*stringThe type of OOB code to generate (e.g., emailVerification, passwordReset)

Return Value

json
{
  "statusCode": 201,
  "data": {
    "link": "https://..."
  },
  "message": "OOB code created successfully"
}

Error Codes

  • 400 Bad Request: Returned when the code cannot be generated.
  • 401 Unauthorized: Returned when permissions are insufficient.

Examples

bash
curl -X POST "https://app.wombat.software/api/{targetPath}/user/:userId/create-oob" \
  -H "Content-Type: application/json" \
  -H "Authentication: Bearer ..." \
  -d '{"type": "emailVerification"}'

ENDPOINTS

post/api/{targetPath}/user/:userId/create-oob