v2

latestOpenAPI 3.0.32026-08-05174296703.4 KB

ops

updateAgent portal_sales_agents

update sales agent information in Auth0

post/ops/sales-agents/{id}

Path parameters

idstring required

Auth0 Sales Agent ID

Example:auth0|63881a171828b3997ad1b3fc

Auth0 Sales Agent ID

Request body

emailstring email required

E-mail

external_agent_idstring

Id number used to identify the sales agent in the seller's internal system

languagestring

User language

last_loginstring date-time

User last login time

namestring required

Name of the agent

phonestring required

Phone number

seller_idstring regexp

Seller ID

seller_store_idstring

Id number used to identify the store a PoS agent is operating from

statusstring

User status

topi_relevantboolean

Whether the user is relevant for driving topi GMV, this allows us to opt out users that are managers or are not expected to do much sales from reporting.

Example request

{
  "email": "alice@example.com",
  "external_agent_id": "abc123",
  "language": "abc123",
  "last_login": "1970-01-01T00:00:01Z",
  "name": "abc123",
  "phone": "abc123",
  "seller_id": "739b63c2-9e58-4964-b38d-4ebb424de242",
  "seller_store_id": "abc123",
  "status": "abc123",
  "topi_relevant": false
}

Response

Accepted response.