Skip to main content
POST
/
v1.0
/
agent
/
profile
/
add
Create a new agent
curl --request POST \
  --url https://api.lofty.com/v1.0/agent/profile/add \
  --header 'Authorization: <authorization>' \
  --header 'Content-Type: <content-type>' \
  --data '
{
  "accountType": 123,
  "accountInfo": {
    "lastName": "Bob",
    "firstName": "Bob",
    "emailAddress": "aaaa@google.com",
    "headUrl": "http://xxx",
    "phoneNumber": "83834748",
    "phoneCode": "000001",
    "phoneCountry": "000001",
    "tagIds": [
      12345,
      67890
    ],
    "sendingEmail": "<string>",
    "domain": "<string>",
    "allowChangeDomain": true,
    "roleName": "role of the agent",
    "groupId": 123,
    "roleId": 123,
    "seatTypeName": "Full Time Agent"
  },
  "workInfo": {
    "streetAddress": "123 Main St",
    "city": "New York",
    "country": "US",
    "state": "NY",
    "zipcode": "10001",
    "licenseId": "xxx",
    "companyName": "xxx",
    "companyAddress": "xxx",
    "position": "xxx",
    "personalWebsite": "xxx",
    "personalAttachments": [
      {
        "fileName": "<string>",
        "size": 123,
        "queryLink": "<string>",
        "contentType": "<string>"
      }
    ],
    "personalDisclaimers": [
      {
        "fileName": "<string>",
        "size": 123,
        "queryLink": "<string>",
        "contentType": "<string>"
      }
    ],
    "personalIntroduction": "xxx"
  },
  "socialMedias": {
    "items": [
      {
        "type": "<string>",
        "name": "<string>",
        "value": "<string>"
      }
    ]
  },
  "personalPhotos": {
    "urls": [
      "<string>"
    ]
  },
  "hasBackOffice": true,
  "agentPid": "<string>",
  "fullSync": true,
  "shouldSync": true,
  "checkRosterNum": true
}
'
{
  "data": 100234,
  "errorCode": 0,
  "errorMsg": "<string>"
}

Documentation Index

Fetch the complete documentation index at: https://developer.lofty.com/llms.txt

Use this file to discover all available pages before exploring further.

Headers

Authorization
string
required

Bearer [access_token]

Content-Type
string
required

application/json

Body

application/json

Agent profile payload.

accountType
integer<int32>
required

The account type of the agent

accountInfo
object
required

Account Base Info of agent, like name , email or phone and something else

workInfo
object

Work Info of agent, include company info etc..

socialMedias
object

Social media of agent, include company info

personalPhotos
object

Personal photos of agent

hasBackOffice
boolean
agentPid
string
fullSync
boolean
shouldSync
boolean
checkRosterNum
boolean

Response

Envelope with the new agent's user ID, or a non-zero errorCode on failure.

Response for POST /v1.0/agent/profile/add. Envelope that carries the new agent's user ID and an error code when creation fails.

data
integer<int64>

User ID of the newly created agent. Zero when creation fails or an existing agent is returned without a new ID.

Example:

100234

errorCode
integer<int32>

Business error code. 0 indicates success.

Example:

0

errorMsg
string

Human-readable error message when errorCode != 0.