Create a user import
POST
/v1/user-importscurl -X POST 'https://api.embodiflow.io/v1/user-imports' \
-H 'Authorization: Bearer $EMBODIFLOW_PAT' \
-H 'Content-Type: application/json' \
-d '{
"rows": [
{
"mode": "invite",
"email": "string",
"role": "owner",
"displayName": "string",
"initialPassword": "string"
}
]
}'Authorization
Send a personal access token with every request.
- Authorization: Bearer PAT
Header parameters
- Idempotency-Keystring
Optional idempotency key, at most 255 characters (UUIDv4 recommended). A repeated key returns the first response byte-for-byte, including a 5xx. The same key with a different body, or a second in-flight request, returns 409 IDEMPOTENCY_CONFLICT. Keys are unique per tenant and retained for 24 hours.
Request body
Content-Typeapplication/json
- rowsarray<UserImportRowBodyDto>required
- modestringrequiredAllowed valuesinvitecreate
- emailstringrequired
- rolestringrequiredAllowed valuesowneradminresearcherbilling_adminviewer
- displayNamestring | null
- initialPasswordstring
Responses
Success
- dataobjectrequired
- idstringrequired
- rowsarray<UserImportRowResultDto>required
- summaryobjectrequired
- metaobjectrequired
- requestIdstringrequired
Response example
{
"data": {
"id": "string",
"rows": [
{
"rowIndex": 0,
"email": "string",
"mode": "invite",
"status": "created",
"userId": "string",
"membershipId": "string",
"invitationId": "string",
"errorCode": "string",
"errorMessage": "string"
}
],
"summary": {
"total": 0,
"succeeded": 0,
"failed": 0
}
},
"meta": {
"requestId": "string"
}
}Servershttps://api.embodiflow.io/v1https://api.embodiflow.dev/v1