post https://evo-integracao-api.w12app.com.br/api/v1/prospects
Example body
Body
{
name(string, required - First Name of the prospect),
email(string, required - E-mail of the prospect),
lastName(string, optional - Last Name of the prospect),
idBranch(int, optional - Branch of the prospect),
ddi(string, optional - Cellphone DDI),
cellphone(string, optional - Cellphone of the prospect),
birthday(DateTime, optional - Birthday of the prospect),
gender(string, optional - Gender of the prospect) { "M" = Male, "F" = Female, "P" = Other },
visit(integer, optional - Origin of the visit of the prospect) { Personal = 1, Email = 2, Telephone = 3, Other = 4 },
marketingType(string, optional - Type of marketing where the prospect met the gym ),
notes(string, optional - Free field for prospect notes),
currentStep(string, optional - Current step in the process for converting the prospect),
AdditionalFieldName(string, optional - Used only in some integrations for data transfer),
AdditionalFieldValue(string, optional - Used only in some integrations for data transfer),
}
Descrição: Endpoint para criação de prospect (potencial cliente)
Tabela de parâmetros de requisição
Parâmetro | Tipo | Descrição | Obrigatório |
---|---|---|---|
name | string | Nome do prospect. | Sim |
string | E-mail do prospect. | Sim | |
lastName | string | Sobrenome do prospect. | Sim |
idBranch | int32 | ID da unidade (filial) associada. | Sim |
ddi | string | Código DDI do telefone (ex: +55). | Não |
cellphone | string | Número de celular do prospect. | Sim |
birthday | date-time | Data de nascimento (formato ISO 8601). | Não |
gender | string | Gênero do prospect {ex: M (Masculino), F(Feminino), p (Outro)}. | Não |
visit | int32 | Código da origem da visita/campanha. | Não |
marketingType | string | Tipo de marketing associado. | Não |
notes | string | Notas ou observações adicionais. | Não |
currentStep | string | Etapa atual no funil de conversão. | Não |
cpf | string | CPF do prospect. | Não |
tokenGympass | string | Token do Gympass (se aplicável). | Não |
additionalFieldName | string | Nome de campo adicional personalizado. | Não |
additionalFieldValue | string | Valor do campo adicional personalizado. | Não |
Resposta
Tabela de parâmetros de requisição
Parâmetro | Tipo | Descrição |
---|---|---|
idProspect | int | Identificador do prospect criado. |