Skip to main content
PATCH
/
salesReps
/
{id}
Updates a Sales Rep
curl --request PATCH \
  --url https://commerce.driv.ly/api/salesReps/{id} \
  --header 'Authorization: <api-key>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "updatedAt": "<string>",
  "createdAt": "<string>",
  "name": "<string>",
  "user": "<string>",
  "phone": "<string>",
  "phoneNumber": "<string>",
  "leads": [
    123
  ],
  "acceptNewLeads": true,
  "assignedLeads": "<string>",
  "creditBands": [
    "Excellent (750-900)"
  ],
  "templates": [
    123
  ]
}
'
{
  "doc": {
    "updatedAt": "<string>",
    "createdAt": "<string>",
    "name": "<string>",
    "user": "<string>",
    "phone": "<string>",
    "phoneNumber": "<string>",
    "leads": [
      123
    ],
    "acceptNewLeads": true,
    "assignedLeads": "<string>",
    "creditBands": [
      "Excellent (750-900)"
    ],
    "templates": [
      123
    ]
  },
  "message": "<string>"
}
Make sure you install our SDK first. You can find out how, and more here.
import { SDK } from '@drivly/commerce'
import type { salesReps } from '@drivly/commerce'

const sdk = new SDK(...)

const salesReps = await sdk.salesReps.update(salesRepsId: string, data: salesReps): Promise<salesReps>

Authorizations

​
Authorization
string
header
required

Path Parameters

​
id
string
required

id of the Sales Rep

Query Parameters

​
depth
number

number of levels to automatically populate relationships and uploads

​
locale
string

retrieves document(s) in a specific locale

​
fallback-locale
string

specifies a fallback locale if no locale value exists

Body

application/json
​
updatedAt
string
required
​
createdAt
string
required
​
name
string | null
​
user
string | null
​
phone
string | null
​
phoneNumber
string | null
​
leads
(number | Lead · object)[] | null
​
acceptNewLeads
boolean | null
​
assignedLeads
string | null
​
creditBands
enum<string>[] | null
Available options:
Excellent (750-900),
Good (700-749),
Fair (650-699),
Fair (600-649),
OK (550-599),
Poor (300-549),
Unknown
​
templates
(number | Template · object)[] | null

Response

ok

​
doc
SalesRep · object
required
​
message
string
required