ops
ops-sales-agents

Create sales agents in bulk

Changed on

Add a bulk of sales agents to the seller portal

post/ops/sales-agents/bulk

Request

  • Base URL
    https://api.topi-staging.eu
  • URL
    https://api.topi-staging.eu/ops/sales-agents/bulk
  • Auth
    OAuth 2
    Authorization code: /oauth2/authorize
    Token URL: /oauth2/token scopes: ops-seller:edit

Request body

Example request

{
  "new_agents": [
    {
      "email": "alice@example.com",
      "external_agent_id": "abc123",
      "name": "abc123",
      "phone": "abc123",
      "seller_id": "739b63c2-9e58-4964-b38d-4ebb424de242",
      "seller_store_id": "abc123"
    }
  ]
}

Response

Created response.

count_new_agentsinteger required

Number of new agents added

failed_agentsstring[]

List of agents that failed to be added

Example response

{
  "count_new_agents": 1,
  "failed_agents": [
    "abc123"
  ]
}

Changes

    • info

      api operation id portal_sales_agents.addBulkAgents removed and replaced with portal_sales_agents#addBulkAgents

    • info

      api operation id portal_sales_agents#addBulkAgents removed and replaced with portal_sales_agents.addBulkAgents

    • info

      api tag ops-sales-agents added