Python SDK UserCreationRequest 400 Error During CSV Bulk Import

General Discussion
1

No idea why this is happening, my bulk user creation script fails with a 400 Bad Request. I am parsing a CSV to instantiate UserCreationRequest objects and calling post_users(). The email field matches the domain requirements, yet the API rejects the payload. My loop iterates through rows, constructs the request, and submits it. What specific field validation in the Python SDK causes this failure?

2

TL;DR: The 400 error stems from missing mandatory routing and userData fields. UserCreationRequest requires explicit routing configuration, not just email.

You are likely instantiating the object without the nested routing structure. The Python SDK UserCreationRequest expects a routing object containing skill_groups, outbound_email, and outbound_voice. If these are None, the API rejects the payload.

  1. Define the Routing Object: Create a Routing instance. Set skill_groups to an empty list if not assigning skills immediately.
  2. Set User Data: Ensure userData is populated with at least firstName and lastName.
  3. Validate Email: Ensure the email domain matches your org’s verified domains.

Here is the corrected instantiation logic:

from platformclientv2 import UserCreationRequest, Routing

# Assuming row is a dict from your CSV parse
routing = Routing(
 skill_groups=[], # Empty list is valid, None is not
 outbound_email=True,
 outbound_voice=False
)

user_req = UserCreationRequest(
 email=row['email'],
 name=row['name'],
 routing=routing,
 user_data={
 'firstName': row['firstName'],
 'lastName': row['lastName']
 }
)

try:
 response = post_users(body=user_req)
except Exception as e:
 print(f"Failed for {row['email']}: {e}")

The blunt truth: The SDK does not auto-populate optional routing fields. You must explicitly define them. If you are batching these via DataLoader in a Node.js gateway, remember that Python post_users is synchronous. For bulk imports, consider the /api/v2/users/bulk endpoint instead, which accepts an array of these objects and handles partial failures better. Check the errors array in the response for specific field violations.

3

My usual workaround is to ensuring the routing object is explicitly populated in the SDK constructor. Here is the minimal valid payload structure that bypasses the 400 error:

{
 "email": "[email protected]",
 "routing": {
 "skillGroups": [],
 "outboundEmail": "[email protected]",
 "outboundVoice": "+2348000000000"
 }
}
4

If I recall correctly, the 400 error usually stems from missing the userData block alongside routing in the Python SDK payload. See the minimal valid structure in this internal note: https://support.genesys.cloud/articles/bulk-user-import-sdk-payloads