---
title: "Invite seller lead"
method: POST
path: "/seller-register/pvt/seller-leads"
tags: ["Seller Invite"]
---

# Invite seller lead

`POST /seller-register/pvt/seller-leads`

This API is used by marketplace operators to invite sellers to join their marketplace. The request sends an email to the seller, inviting sellers to activate their store. The invitation's link in the email is unique per user, and available for only seven days for the seller to click and begin activating their store. 

The email template is completely customizable. All email templates that VTEX sends to seller leads can be found and edited in the marketplace's VTEX Admin, on the Message Center section.

## Permissions

Any user or [API key](https://developers.vtex.com/docs/guides/api-authentication-using-api-keys) must have at least one of the appropriate [License Manager resources](https://help.vtex.com/en/tutorial/license-manager-resources--3q6ztrC8YynQf6rdc6euk3) to be able to successfully run this request. Otherwise they will receive a status code `403` error. These are the applicable resources for this endpoint:

| **Product** | **Category** | **Resource** |
| --------------- | ----------------- | ----------------- |
| Seller Register | Seller Administration | **View Seller** |

You can [create a custom role](https://help.vtex.com/en/tutorial/roles--7HKK5Uau2H6wxE1rH5oRbc#creating-a-role) with that resource or use one of the following [predefined roles](https://help.vtex.com/en/tutorial/predefined-roles--jGDurZKJHvHJS13LnO7Dy):

| **Role** | **Resource** | 
| --------------- | ----------------- | 
| Seller manager | View Seller |

>❗ Assigning a [predefined role](https://help.vtex.com/en/tutorial/predefined-roles--jGDurZKJHvHJS13LnO7Dy) to users or application keys usually grants permission to multiple [License Manager resources](https://help.vtex.com/en/tutorial/license-manager-resources--3q6ztrC8YynQf6rdc6euk3). If some of these permissions are not necessary, consider creating a custom role instead. For more information regarding security, see [Best practices for using application keys](https://help.vtex.com/en/tutorial/best-practices-api-keys--7b6nD1VMHa49aI5brlOvJm).

## Path parameters

- `accountName` string, required
- `environment` string, required

## Headers

- `Accept` string, required
- `Content-Type` string, required

## Request body

- CreateSellerLeadRequest — Request to create a seller lead. This includes detailed information about the seller, such as their email, name, account name, trade policy, contact email, seller type, account ID, accountable person, acceptance of legal terms, address, and document details.
  - `sellerEmail` string, required — Seller's contact email.
  - `sellerName` string, required — Seller's store's name.
  - `sellerAccountName` string, required — Name of the seller's account, part of the url of their VTEX Admin.
  - `salesChannel` string, required — Sales channel ([trade policy](https://help.vtex.com/en/tutorial/how-trade-policies-work--6Xef8PZiFm40kg2STrMkMV)) associated to the seller account created.
  - `email` string, required — The email address associated with the seller. It should be in a valid email format.
  - `sellerType` integer, required — Type of seller, which can be: `1`: Regular seller `2`: White label seller.
  - `accountId` string, required — Marketplace's account ID.
  - `document` string, required — Company's legal document number.
  - `hasAcceptedLegalTerms` boolean, required — Indicates if the seller has accepted the platform's legal terms and conditions.
  - `address` Address, required — Details of the address associated with the seller. This includes postal code, complement, street, number, neighborhood, state, and city.
    - `postalcode` string, required — Postal code from the seller's address.
    - `complement` string, required — Seller's address complement.
    - `street` string, required — Street information, from the seller's address.
    - `number` string, required — Street's number, from the seller's address.
    - `neighborhood` string, required — Seller's address neighborhood.
    - `state` string, required — State, from the seller's address.
    - `city` string, required — City name, from the seller's address.
  - `accountable` Accountable, required — Details of the person accountable for the seller's account. This includes their name, email address, and phone number.
    - `name` string, required — Name of the person responsible for the seller.
    - `email` string, required — Email address of the person responsible for the seller.
    - `phone` string, required — Phone number of the person responsible for the seller.

## Response `200`

OK

- ResponseCreateSellerLead — Response object for creating a seller lead. It includes details about the created seller, such as their ID, the creation date, and the date of the last update.
  - `sellerId` string — ID of the created seller.
  - `createdAt` string — Creation date of the seller.
  - `updatedAt` string — Date of the last update of the seller.

---

[API](https://skmtc.net/vtex/apis/marketplace-api.md) · [All operations](https://skmtc.net/vtex/apis/marketplace-api/llms.txt) · [OpenAPI document](https://skmtc-service-staging.skmtc.workers.dev/v1/apis/vtex/marketplace-api/revisions/27e83b4cc9ac/schema)