# Onboard leads

Source: https://developer.avalara.com/products/mylodge/integration-guides/mylodgetax/dyg3486672965194/

Guide: MyLodgeTax

# Onboard leads

Learn how to use the addPartnerLead endpoint to create new partner leads and manage their account creation process.

**Element type**: Required

**Endpoint/model**: [addPartnerLead](https://developer.avalara.com/api-reference/myLodgeAPI/v1/methods/Onboarding/addPartnerLead/)

The [addPartnerLead](https://developer.avalara.com/api-reference/myLodgeAPI/v1/methods/Onboarding/addPartnerLead/) endpoint creates a new partner lead with the provided contact and location information and returns a link where the lead can complete their Avalara MyLodgeTax account creation.

This endpoint receives information about the potential customer and one or more locations and securely stores the information provided in the request. Unique customer and location identifiers must be included in the request body.

For leads with an email address not already associated with an account in the Avalara MyLodgeTax system, the response contains a link that uniquely identifies the request. The link can be used by the lead or the calling application to display a page where the user can complete the Avalara MyLodgeTax account creation process.

For leads that already exist in the Avalara MyLodgeTax system, based on the provided email address, the response returns a link that directs the existing customer to create additional properties in the Avalara MyLodgeTax application.

Note

The [addPartnerLead](https://developer.avalara.com/api-reference/myLodgeAPI/v1/methods/Onboarding/addPartnerLead/) request accepts a maximum of 120 properties.

```
{
    "customer": {
        "customerID": "123", // partner system identifier for customer
        "firstName": "Ava",
        "lastName": "Lara",
        "email": "ava.lara@avalara.com",
        "phoneNumber": "866-555-1110",
        "billingAddress": {
            "addressLine1": "255 S King St",
            "addressLine2": "",
            "city": "Seattle",
            "state": "WA",
            "country": "US",
            "postalCode": "98104"
        }
    },
    "locations": [
        {
            "locationId": "001", // partner system identifier for location
            "nickname": "HQ", // user-friendly name for location
            "address": {
                "addressLine1": "255 S King St",
                "addressLine2": "",
                "city": "Seattle",
                "state": "WA",
                "country": "US",
                "postalCode": "98104"
            }
        }
    ]
}
```