Creates a structured lead, including contact and deal attributes

POST/jsonapi/structured-leads

The external-reference attributes apply to the resulting deal, not each contact in the contacts array. See the external integrations and references guide for name lookup and allow-create behavior.

For client-credentials integrations, supply your assigned adviser identifier in the UserId header. See request headers and data access.

Access

Bearer authentication. Confirm your scopes, data access and required adviser context.

Request parameters

No parameters are defined for this operation in the source contract. Authentication and applicable request headers still apply.

Request body

application/vnd.api+json

Example request body

Generated from the OpenAPI Specification with illustrative values. Replace sample values, resource types and IDs with your own. Optional fields are shown for illustration; follow the field descriptions and business rules.

{
  "data": {
    "type": "structured-leads",
    "attributes": {
      "categoriesAllowCreate": false,
      "categories": [
        "string"
      ],
      "contacts": [
        {
          "lid": "string",
          "title": "Mr",
          "firstName": "Alex",
          "preferredName": "Alex",
          "lastName": "Morgan",
          "email": "alex@example.com",
          "mobile": "+61400000000",
          "homePhone": "+61400000000",
          "businessPhone": "+61400000000",
          "dateOfBirthAsString": "1990-01-15",
          "dateOfBirth": "1990-01-15T00:00:00Z",
          "gender": "Male",
          "maritalStatus": "Single",
          "hasMarketingConsent": false,
          "isGuarantor": false,
          "isDependant": false,
          "isPrimary": false,
          "addresses": [
            {
              "lid": "string"
            }
          ],
          "employments": [
            {
              "lid": "string"
            }
          ]
        }
      ],
      "addresses": [
        {
          "lid": "string",
          "formattedAddress": "string",
          "streetAddress": "string",
          "suburb": "string",
          "state": "string",
          "postCode": "stri",
          "country": "string",
          "addressType": "Current"
        }
      ],
      "assets": [
        {
          "lid": "string",
          "assetTypeId": 1,
          "assetSubTypeId": 1,
          "description": "string",
          "value": 1,
          "institution": "string",
          "accountName": "string",
          "bsb": "string",
          "accountNumber": "string",
          "vehicleMake": "string",
          "vehicleYear": 1,
          "propertyZoningId": 1,
          "propertyTypeId": 1,
          "propertyPrimaryPurpose": "PurchaseOwnerOccupied",
          "valueBasis": "ApplicantEstimate",
          "address": {
            "lid": "string"
          },
          "ownership": [
            {
              "lid": "string"
            }
          ]
        }
      ],
      "expenses": [
        {
          "lid": "string",
          "expenseTypeId": 1,
          "description": "string",
          "value": 1,
          "frequency": "Yearly",
          "ownership": [
            {
              "lid": "string"
            }
          ]
        }
      ],
      "incomes": [
        {
          "lid": "string",
          "incomeTypeId": 1,
          "description": "string",
          "value": 1,
          "frequency": "Yearly",
          "incomeVerification": "CurrentPayslips",
          "ownership": [
            {
              "lid": "string"
            }
          ],
          "asset": {
            "lid": "string"
          },
          "employment": {
            "lid": "string"
          }
        }
      ],
      "liabilities": [
        {
          "lid": "string",
          "liabilityTypeId": 1,
          "liabilitySubTypeId": 1,
          "description": "string",
          "accountName": "string",
          "bsb": "string",
          "accountNumber": "string",
          "value": 1,
          "limit": 1,
          "repayments": 1,
          "repaymentFrequency": "Yearly",
          "interestRate": 1,
          "interestTaxDeductible": false,
          "creditorName": "string",
          "loanTerm": 1,
          "loanRepaymentType": "InterestOnly",
          "mortgagePriority": "First",
          "asset": {
            "lid": "string"
          },
          "ownership": [
            {
              "lid": "string"
            }
          ]
        }
      ],
      "employments": [
        {
          "lid": "string",
          "employmentStatus": "PrimaryEmployment",
          "employmentType": "PAYG",
          "dateStartedAsString": "2026-01-15",
          "dateStarted": "2026-01-15T09:00:00Z",
          "dateEndedAsString": "2026-01-15",
          "dateEnded": "2026-01-15T09:00:00Z",
          "employmentRoleName": "string",
          "employmentBasis": "FullTime",
          "isProbation": false,
          "businessNumber": "string",
          "companyNumber": "string",
          "employerName": "string",
          "employerContactTitle": "Mr",
          "employerContactFirstName": "string",
          "employerContactLastName": "string",
          "employerType": "Private",
          "employerPhone": "string",
          "address": {
            "lid": "string"
          }
        }
      ],
      "utmSource": "string",
      "utmMedium": "string",
      "utmCampaign": "string",
      "utmTerm": "string",
      "utmContent": "string",
      "sourceId": 1,
      "sourceCategoryId": 1,
      "sourceReferrerId": "string",
      "sourceAdditionalDetails": "string",
      "sourceSystemUrl": "string",
      "dealName": "string",
      "noteTitle": "string",
      "noteDetails": "string",
      "externalReference": "string",
      "externalIntegration": "string",
      "externalIntegrationAllowCreate": false,
      "sendNotification": false
    }
  }
}

Request documentobjectStructuredLeadDocument ↗

dataobjectrequiredStructuredLead ↗

Example request

Use your supplied API base URL and replace path placeholders such as {id}. These examples run in your backend or terminal, where your credentials are kept.

curl --globoff --request POST "${API_BASE_URL}/jsonapi/structured-leads" \
  --header "Authorization: Bearer $ACCESS_TOKEN" \
  --header "UserId: $ADVISER_CONTACT_ID" \
  --header 'Accept: application/vnd.api+json' \
  --header 'Content-Type: application/vnd.api+json' \
  --data '{
  "data": {
    "type": "structured-leads",
    "attributes": {
      "categoriesAllowCreate": false,
      "categories": [
        "string"
      ],
      "contacts": [
        {
          "lid": "string",
          "title": "Mr",
          "firstName": "Alex",
          "preferredName": "Alex",
          "lastName": "Morgan",
          "email": "alex@example.com",
          "mobile": "+61400000000",
          "homePhone": "+61400000000",
          "businessPhone": "+61400000000",
          "dateOfBirthAsString": "1990-01-15",
          "dateOfBirth": "1990-01-15T00:00:00Z",
          "gender": "Male",
          "maritalStatus": "Single",
          "hasMarketingConsent": false,
          "isGuarantor": false,
          "isDependant": false,
          "isPrimary": false,
          "addresses": [
            {
              "lid": "string"
            }
          ],
          "employments": [
            {
              "lid": "string"
            }
          ]
        }
      ],
      "addresses": [
        {
          "lid": "string",
          "formattedAddress": "string",
          "streetAddress": "string",
          "suburb": "string",
          "state": "string",
          "postCode": "stri",
          "country": "string",
          "addressType": "Current"
        }
      ],
      "assets": [
        {
          "lid": "string",
          "assetTypeId": 1,
          "assetSubTypeId": 1,
          "description": "string",
          "value": 1,
          "institution": "string",
          "accountName": "string",
          "bsb": "string",
          "accountNumber": "string",
          "vehicleMake": "string",
          "vehicleYear": 1,
          "propertyZoningId": 1,
          "propertyTypeId": 1,
          "propertyPrimaryPurpose": "PurchaseOwnerOccupied",
          "valueBasis": "ApplicantEstimate",
          "address": {
            "lid": "string"
          },
          "ownership": [
            {
              "lid": "string"
            }
          ]
        }
      ],
      "expenses": [
        {
          "lid": "string",
          "expenseTypeId": 1,
          "description": "string",
          "value": 1,
          "frequency": "Yearly",
          "ownership": [
            {
              "lid": "string"
            }
          ]
        }
      ],
      "incomes": [
        {
          "lid": "string",
          "incomeTypeId": 1,
          "description": "string",
          "value": 1,
          "frequency": "Yearly",
          "incomeVerification": "CurrentPayslips",
          "ownership": [
            {
              "lid": "string"
            }
          ],
          "asset": {
            "lid": "string"
          },
          "employment": {
            "lid": "string"
          }
        }
      ],
      "liabilities": [
        {
          "lid": "string",
          "liabilityTypeId": 1,
          "liabilitySubTypeId": 1,
          "description": "string",
          "accountName": "string",
          "bsb": "string",
          "accountNumber": "string",
          "value": 1,
          "limit": 1,
          "repayments": 1,
          "repaymentFrequency": "Yearly",
          "interestRate": 1,
          "interestTaxDeductible": false,
          "creditorName": "string",
          "loanTerm": 1,
          "loanRepaymentType": "InterestOnly",
          "mortgagePriority": "First",
          "asset": {
            "lid": "string"
          },
          "ownership": [
            {
              "lid": "string"
            }
          ]
        }
      ],
      "employments": [
        {
          "lid": "string",
          "employmentStatus": "PrimaryEmployment",
          "employmentType": "PAYG",
          "dateStartedAsString": "2026-01-15",
          "dateStarted": "2026-01-15T09:00:00Z",
          "dateEndedAsString": "2026-01-15",
          "dateEnded": "2026-01-15T09:00:00Z",
          "employmentRoleName": "string",
          "employmentBasis": "FullTime",
          "isProbation": false,
          "businessNumber": "string",
          "companyNumber": "string",
          "employerName": "string",
          "employerContactTitle": "Mr",
          "employerContactFirstName": "string",
          "employerContactLastName": "string",
          "employerType": "Private",
          "employerPhone": "string",
          "address": {
            "lid": "string"
          }
        }
      ],
      "utmSource": "string",
      "utmMedium": "string",
      "utmCampaign": "string",
      "utmTerm": "string",
      "utmContent": "string",
      "sourceId": 1,
      "sourceCategoryId": 1,
      "sourceReferrerId": "string",
      "sourceAdditionalDetails": "string",
      "sourceSystemUrl": "string",
      "dealName": "string",
      "noteTitle": "string",
      "noteDetails": "string",
      "externalReference": "string",
      "externalIntegration": "string",
      "externalIntegrationAllowCreate": false,
      "sendNotification": false
    }
  }
}'

Responses

201 response

Response headers

Location — Location of newly created resource

application/vnd.api+json

201 responseobjectStructuredLeadDocument ↗

metaobjectread only

jsonApiobjectread only

linksall ofread only

dataobjectrequiredStructuredLead ↗

includedarray · nullableread only

For guidance beyond this operation's schema, see troubleshooting and JSON:API explained.