API
View as Markdown

Update an external agent

POSThttp://localhost:4000/api/externalAgents/update

Changes an external agent. Send only the fields you want to change.

Your API key needs the externalAgents.MANAGE permission.

Body Params

idintegerrequired

ID of the external agent.

firstNamestring

First name.

lastNamestring

Last name.

emailstring

Email address.

genderenum

Gender.

companystring

Agency the person works for.

countrystring

Country name.

citystring

City.

addressstring

Street address.

phoneCountryCodestring

Two-letter country code of the phone number.

phoneDialCodeinteger

Dial code without the plus sign.

phoneinteger

National phone number, digits only.

notesstring

Notes.

externalLinksarray of values

Links to profiles on other sites.

Responses

200Successful response.
400The request is not valid.
401The API key is missing, invalid, expired or disabled.
403The API key does not have the permission this endpoint needs.