Agent Numbers

Update an agent number

Update an agent number. tenantAdmin or agencyAdmin is required.

put/agentnumbers/{id}

Request

  • Base URL
    https://api.surense.com/api/v1
  • URL
    https://api.surense.com/api/v1/agentnumbers/{id}
  • Auth
    OAuth 2
    Client credentials
    Token URL: https://api.surense.com/oauth/token

Path parameters

idstring uuid required

Request body

agencyIdstring required

Agency ID

descriptionstring

Description

licenseeIdstring required

Licensee ID

supervisorIdstring

Supervisor ID

customerManagerIdstring

Customer manager ID

misparSohenAv1string

Agent number AV1

misparSohenAv2string

Agent number AV2

blackListedboolean

Whether the agent number is blacklisted

activeboolean required

Whether the agent number is active

notesstring

Notes

Example request

{
  "agencyId": "123e4567-e89b-12d3-a456-426614174000",
  "description": "Agent number description",
  "licenseeId": "123e4567-e89b-12d3-a456-426614174000",
  "supervisorId": "123e4567-e89b-12d3-a456-426614174000",
  "customerManagerId": "123e4567-e89b-12d3-a456-426614174000",
  "misparSohenAv1": "123456",
  "misparSohenAv2": "123456",
  "active": true,
  "notes": "Additional notes"
}

Response

OK

tenantIdstring uuid
agencyIdstring uuid
createdDatestring date-time
createdBystring uuid
creatorNamestring
lastModifiedDatestring date-time
lastModifiedBystring uuid
versioninteger
idstring uuid
descriptionstring
companyIdinteger
licenseeIdstring uuid
licenseeNamestring
supervisorIdstring uuid
supervisorNamestring
businessClassIdstring uuid
businessClassNamestring
customerManagerIdstring uuid
customerManagerNamestring
misparSohenstring
misparSohenAv1string
misparSohenAv2string
blacklistedboolean
activeboolean
statusDatestring date-time
notesstring

Changes

No recorded changes to this operation across all 1 revision of this API.