SKskyfire

Create Organization User Seller Agent

Changed on

As an Organization Admin, create a seller agent for a user in your organization.

post/api/v1/organizations/users/{userId}/agents/seller

Request

  • Base URL
    https://api.skyfire.xyz
  • URL
    https://api.skyfire.xyz/api/v1/organizations/users/{userId}/agents/seller
  • Auth
    API key in header skyfire-api-key

Path parameters

userIdstring uuid required

Unique identifier of the organization user who will own the seller agent. Must be a user in your own organization. e.g. "906fc259-ef0a-4736-bdcd-c1d5a78db483"

Request body

displayNamestring required

Label for the new seller agent. Does not have to be unique. e.g. "Chloe Cupcakes".

Response

Ok

idstring required

Unique identifier of the created seller agent.

apiKeystring required

API key for the seller agent. Returned only in this response and cannot be retrieved again, store it securely.

Example response

{
  "id": "906fc259-ef0a-4736-bdcd-c1d5a78db483"
}

Changes