Skip to navigation
Vendor/ Customer APIsPartner

Add users to a partner

View as MarkdownOpen in Claude

Invites one or more additional people into a partner company that is already connected to your vendor account. Each user is created and sent a portal invite email.

This is all-or-nothing. Every email address is validated before anything is written, so a single bad entry rejects the whole batch and no users are created. A batch is rejected if any emailAddress already belongs to an existing user, or if the same address appears more than once in the request.

Authentication

X-API-KEYstring

Your vendor API key. Required on every request under /api/v1/vendors/**.

Path parameters

partnerIdlongRequired
ID of the partner to add users to.

Request

This endpoint expects an object.
userslist of objectsRequired

Response

Users invited successfully.
successbooleanOptional
messagestringOptional
datalist of objectsOptional
timestampdatetimeOptional

Errors

400
Bad Request Error
401
Unauthorized Error
404
Not Found Error
500
Internal Server Error