Create Organization User Buyer Agent

As an Organization Admin, create an ungrouped buyer agent for an organization user, with a wallet and one API key.

Recent Requests
Log in to see full request history
TimeStatusUser Agent
Retrieving recent requests…
LoadingLoading…

Authenticate with an Organization Admin User API key, sent in the skyfire-api-key header. Keys belonging to Organization Admins are accepted; a MEMBER key, or any Agent API key, is rejected with 401.

The user must belong to your organization and be active: an unknown user returns 404 and a deactivated user returns 400.

One ungrouped buyer per user

A user holds at most one ungrouped buyer agent, and a deactivated one still counts. Most users already have one, created as Buyer 1 by Create Organization User. This endpoint is for users who were created directly into an agent group and so have no buyer of their own, or whose buyer was never created. If the user already has an ungrouped buyer, the call returns 409; reactivate or rename the existing agent with Update Organization User Agent instead.

Agents that belong to agent groups do not count toward this limit. A user may be enrolled in any number of groups alongside their own buyer.

Naming rules

displayName must be printable ASCII, 1 to 100 characters, with at least one non-space character. Names are compared case-insensitively with whitespace trimmed and collapsed. The name must be free among the user's active agents, and may not match an active agent group in your organization. Either collision returns 409. All checks run before anything is provisioned, so a refused request creates nothing.

apiKey is returned only in this response and cannot be retrieved again. Store it securely before discarding the response. Further keys can be created with Create Agent API Key.

Path Params
uuid
required

Unique identifier of the organization user. e.g. "906fc259-ef0a-4736-bdcd-c1d5a78db483"

Body Params
string
required
length between 1 and 100

Display name of the new agent, shown to sellers as aid.name. Printable ASCII with at least one non-space character, 1 to 100 characters. Must be free among the user's active agents and not match an active agent group in your organization. e.g. "Procurement Agent"

Responses

Language
Credentials
Header
LoadingLoading…
Response
Choose an example:
application/json