Skip to main content
POST
Add several people to the owner directory at once, the way a CSV import does. Like Create Owner, this creates labels rather than accounts: no email is sent, no seat is used, and nobody gains access to your workspace. The call is safe to repeat. An address that already belongs to a current owner is skipped, and an address belonging to an owner you deleted brings that owner back. The response tallies each case. A row’s name is written only when you send one, so re-importing a file with the emails alone keeps the names already in the directory.
email is the only field a row needs. The name is optional here, unlike in Create Owner.

​
Partial success

Each row is checked on its own. A file of 200 rows with one malformed address adds 199 owners and reports the one it dropped. The request only fails outright when every row is unusable. Rows counted as skipped are the ones that changed nothing:
  • the email was missing or malformed
  • the same email appeared earlier in the same request
  • the email already belonged to a current owner
A workspace holds at most 2000 owners. The cap is checked against the number of rows you send, not the number that turn out to be new, so re-importing a 400-row file into a directory that already holds those 400 owners is rejected with 400 even though it would have added nobody. Import in batches, or send only the rows you are adding.

Authorizations

​
Authorization
string
header
required

The API key you created on the API settings page of the Clustr app.

Body

application/json
​
owners
object[]
required

The owners to add: at least 1 and at most 2,000.

Response

Owners processed

​
success
boolean
​
data
object