Skip to main content
PATCH
/
salesreps
/
{id}
Update an existing Sales Rep
curl --request PATCH \
  --url https://commerce.driv.ly/api/salesreps/{id} \
  --header 'Content-Type: application/json' \
  --data '
{
  "id": "<string>",
  "agent": "<string>",
  "address": "<string>",
  "primaryPhoneNumber": "<string>",
  "primaryEmail": "<string>",
  "lastName": "<string>",
  "firstName": "<string>",
  "emails": [
    "<string>"
  ],
  "phoneNumbers": [
    "<string>"
  ],
  "roles": [
    "<string>"
  ],
  "creditBands": [
    "<string>"
  ],
  "templates": [
    "<string>"
  ],
  "isAcceptingNewLeads": true
}
'
{
  "data": {
    "id": "<string>",
    "lastName": "<string>",
    "firstName": "<string>",
    "agent": "<string>",
    "address": "<string>",
    "primaryPhoneNumber": "<string>",
    "primaryEmail": "<string>",
    "emails": [
      "<string>"
    ],
    "phoneNumbers": [
      "<string>"
    ],
    "roles": [
      "<string>"
    ],
    "creditBands": [
      "<string>"
    ],
    "templates": [
      "<string>"
    ],
    "isAcceptingNewLeads": true
  },
  "success": true
}

Path Parameters

id
string
required

Contact is uniquely identified by id

Query Parameters

depth
integer

The number of levels of related objects to include in the response

Body

application/json
id
string

Contact is uniquely identified by id

agent

Contact is automated Agent

address

Contact has Address

primaryPhoneNumber
string

Contact has Primary Phone Number

primaryEmail
string<idn-email>

Contact has Primary Email

lastName
string

Contact has Last Name

firstName
string

Contact has First Name

emails
string<idn-email>[]

Contact has Email

phoneNumbers
string[]

Contact has Phone Number

roles
string[]

Contact has Role

creditBands
(string | Credit Band · object)[]

Sales Rep accepts leads from Credit Band

templates
(string | Template · object)[]

Sales Rep uses Template

isAcceptingNewLeads
boolean

Sales Rep is accepting new leads

Response

Sales Rep Updated

data
Sales Rep · object
success
boolean