API
View as Markdown

Create an external agent

POSThttp://localhost:4000/api/externalAgents/create

Adds an external agent.

Your API key needs the externalAgents.MANAGE permission.

Body Params

firstNamestringrequired

First name.

lastNamestring

Last name.

emailstring

Email address.

genderenumrequired

Gender.

companystring

Agency the person works for.

countrystringrequired

Country name.

citystring

City.

addressstring

Street address.

phoneCountryCodestringrequired

Two-letter country code of the phone number.

phoneDialCodeintegerrequired

Dial code without the plus sign.

phoneintegerrequired

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.