Siga a estrutura de pergunta recomendada pelo Dev Bot antes de enviar suas dúvidas de integração.
- Boas vindas 💜
- 📃 Guias
- 🌐 API Reference
- AccessControl
- Activities
- Get activities
- Get activities schedule
- Get activities schedule details
- Enroll member in activity schedule
- Change status of a member in activity schedule
- Create a new experimental class and enroll the member on it
- List of spots that are already filled in the activity session
- Get activities schedule by idService or idMembership
- Get activities enrollment by member or membership
- Create a new enrollment for a member
- Delete enrollment
- Get enrollment details for a member
- Appointments
- BankAccounts
- Carts
- Configuration
- Employees
- Get employees
- Get employees
- Get employees
- Get employees
- Add employees
- Add employees
- Add employees
- Update employees
- Update employees
- Update employees
- Delete employees
- Delete employees
- Delete employees
- Retrieves employee permissions.
- Retrieves employee permissions.
- Retrieves employee permissions.
- Add employees
- Update employees
- Delete employees
- Retrieves employee permissions.
- Entries
- Invoices
- Management
- MemberMembership
- Members
- Get member profile
- Get member profile
- Get member profile
- Get member profile
- Get members
- Get members
- Get members
- Retrieves active members from a specific branch or from all branches
- Retrieves active members from a specific branch or from all branches
- Retrieves active members from a specific branch or from all branches
- Get member services
- Get member services
- Get member services
- Update a member card number
- Update a member card number
- Update a member card number
- Authenticate member
- Authenticate member
- Authenticate member
- Get link for reset password
- Get link for reset password
- Get link for reset password
- Update a member fitcoins
- Update a member fitcoins
- Update a member fitcoins
- Get member fitcoins
- Get member fitcoins
- Get member fitcoins
- Get basic member information.
- Get basic member information.
- Get basic member information.
- Get member's latest branch transfer
- Get member's latest branch transfer
- Get member's latest branch transfer
- Update basic member data
- Update basic member data
- Update basic member data
- Transfers a member from one branch to another
- Transfers a member from one branch to another
- Transfers a member from one branch to another
- Block/unblock member
- Block/unblock member
- Block/unblock member
- Send push notification to a specific member
- Get members
- Retrieves active members from a specific branch or from all branches
- Get member services
- Update a member card number
- Authenticate member
- Get link for reset password
- Update a member fitcoins
- Get member fitcoins
- Get basic member information.
- Get member's latest branch transfer
- Update basic member data
- Transfers a member from one branch to another
- Block/unblock member
- Send push notification to a specific member
- Send push notification to multiple members
- Membership
- Notifications
- Parking
- Partnership
- Payables
- Pix
- Product
- Prospects
- Receivables
- Gets a list of debts and current status (Similar to the Collections - Default report)
- Creates batch collection attempts for the member membership contracts.
- Reverses a list of received (paid) receivables back to open status
- Gets the details of a specific charge batch.
- Get receivables
- Marks a list of receivables as received (paid)
- Get cost center
- Get receivables conciliation report
- Sales
- Service
- States
- Voucher
- Webhook
- Workout
- Get all default workouts
- Get all default workouts
- Get all default workouts
- Link workout for client
- Link workout for client
- Link workout for client
- Change data from a client's prescribed workout
- Change data from a client's prescribed workout
- Change data from a client's prescribed workout
- Get all client's or prospect's or employee's workouts by month, year or idProfessor
- Get all client's or prospect's or employee's workouts by month, year or idProfessor
- Get all client's or prospect's or employee's workouts by month, year or idProfessor
- Get all Exercises
- Get all Exercises
- Get all Exercises
- Get all default workouts of the new prescription
- Get all default workouts of the new prescription
- Get all default workouts of the new prescription
- Get all client's or prospect's or employee's workouts of the new prescription
- Get all client's or prospect's or employee's workouts of the new prescription
- Get all client's or prospect's or employee's workouts of the new prescription
- Get all client's or prospect's or employee's workouts of the new prescription by month, year or idProfessor
- Get all client's or prospect's or employee's workouts of the new prescription by month, year or idProfessor
- Get all client's or prospect's or employee's workouts of the new prescription by month, year or idProfessor
- Link workout of the new prescription for client
- Link workout of the new prescription for client
- Link workout of the new prescription for client
- Change data from a client's prescribed workout
- Get all Exercises
- Get all default workouts of the new prescription
- Get all client's or prospect's or employee's workouts of the new prescription
- Get all client's or prospect's or employee's workouts of the new prescription by month, year or idProfessor
- Link workout of the new prescription for client
- Create a workout of the new prescription
- 🌐 API Reference Copy
- AccessControl
- Activities
- Get activities
- Get activities schedule
- Get activities schedule details
- Enroll member in activity schedule
- Change status of a member in activity schedule
- Create a new experimental class and enroll the member on it
- List of spots that are already filled in the activity session
- Get activities schedule by idService or idMembership
- Get activities enrollment by member or membership
- Create a new enrollment for a member
- Delete enrollment
- Get enrollment details for a member
- Appointments
- BankAccounts
- Carts
- Configuration
- Employees
- Add employees
- Retrieves employee permissions.
- Retrieves employee permissions.
- Retrieves employee permissions.
- Delete employees
- Delete employees
- Delete employees
- Update employees
- Update employees
- Update employees
- Get employees
- Add employees
- Add employees
- Get employees
- Get employees
- Get employees
- Retrieves employee permissions.
- Delete employees
- Update employees
- Add employees
- Entries
- Invoices
- Management
- MemberMembership
- Members
- Get basic member information.
- Update a member card number
- Authenticate member
- Authenticate member
- Authenticate member
- Get link for reset password
- Get link for reset password
- Get link for reset password
- Update a member fitcoins
- Update a member fitcoins
- Update a member fitcoins
- Get member fitcoins
- Get member fitcoins
- Get member fitcoins
- Get basic member information.
- Update a member card number
- Get basic member information.
- Get member's latest branch transfer
- Get member's latest branch transfer
- Get member's latest branch transfer
- Update basic member data
- Update basic member data
- Update basic member data
- Transfers a member from one branch to another
- Transfers a member from one branch to another
- Transfers a member from one branch to another
- Block/unblock member
- Block/unblock member
- Block/unblock member
- Send push notification to a specific member
- Send push notification to a specific member
- Get members
- Retrieves active members from a specific branch or from all branches
- Get member services
- Update a member card number
- Authenticate member
- Get link for reset password
- Update a member fitcoins
- Get member fitcoins
- Get basic member information.
- Get member's latest branch transfer
- Update basic member data
- Transfers a member from one branch to another
- Block/unblock member
- Get member profile
- Send push notification to multiple members
- Get member profile
- Get member profile
- Get member profile
- Get members
- Get members
- Get members
- Retrieves active members from a specific branch or from all branches
- Retrieves active members from a specific branch or from all branches
- Retrieves active members from a specific branch or from all branches
- Get member services
- Get member services
- Get member services
- Update a member card number
- Membership
- Notifications
- Parking
- Partnership
- Payables
- Pix
- Product
- Prospects
- Receivables
- Gets a list of debts and current status (Similar to the Collections - Default report)
- Creates batch collection attempts for the member membership contracts.
- Gets the details of a specific charge batch.
- Get receivables
- Marks a list of receivables as received (paid)
- Get cost center
- Get receivables conciliation report
- Sales
- Service
- States
- Voucher
- Webhook
- Workout
- Get all client's or prospect's or employee's workouts of the new prescription
- Get all client's or prospect's or employee's workouts by month, year or idProfessor
- Get all client's or prospect's or employee's workouts by month, year or idProfessor
- Get all client's or prospect's or employee's workouts by month, year or idProfessor
- Get all Exercises
- Get all Exercises
- Get all Exercises
- Get all default workouts of the new prescription
- Get all default workouts of the new prescription
- Get all default workouts of the new prescription
- Change data from a client's prescribed workout
- Get all client's or prospect's or employee's workouts of the new prescription
- Get all client's or prospect's or employee's workouts of the new prescription
- Get all client's or prospect's or employee's workouts of the new prescription by month, year or idProfessor
- Get all client's or prospect's or employee's workouts of the new prescription by month, year or idProfessor
- Get all client's or prospect's or employee's workouts of the new prescription by month, year or idProfessor
- Link workout of the new prescription for client
- Link workout of the new prescription for client
- Link workout of the new prescription for client
- Change data from a client's prescribed workout
- Get all default workouts of the new prescription
- Get all client's or prospect's or employee's workouts of the new prescription
- Get all client's or prospect's or employee's workouts of the new prescription by month, year or idProfessor
- Link workout of the new prescription for client
- Create a workout of the new prescription
- Get all Exercises
- Get all default workouts
- Get all default workouts
- Get all default workouts
- Link workout for client
- Link workout for client
- Link workout for client
- Change data from a client's prescribed workout
- Change data from a client's prescribed workout
- AccessControl
- Esquemas
- Schemas
- ActivityGroupApiViewModel
- ActivityAreaViewModel
- ActiveMembersReturnViewModel
- AtividadeAgendaApiViewModel
- ActivityEmployeesViewModel
- ActivityGroupViewModel
- AtividadeBasicoApiViewModel
- AtividadeAgendaApiCustomViewModel
- ActivityResourcesViewModel
- AtividadeListApiViewModel
- ActivityUnavailability
- AddressFamily
- AtividadeLugarReservaApiViewModel
- AreaBloqueioAgendaApiViewModel
- AtividadeLugarReservaViewModel
- AsnEncodedData
- AtividadeSessaoParticipanteApiViewModel
- AtividadeAgendaListApiViewModel
- BairroViewModel
- Assembly
- AsymmetricAlgorithm
- BandeirasBasicoViewModel
- BankAccountsViewModel
- BasicFreezeViewModel
- BasicMemberMembershipApiViewModel
- AtividadeSessaoAgendaViewModel
- BonusSessionViewModel
- BusinessHoursViewModel
- CardDataViewModel
- CardTranslationViewModel
- CartIdViewModel
- CartItemsViewModel
- CartViewModel
- CidadeViewModel
- BloqueioAgendaApiViewModel
- ClienteDetalhesBasicosApiViewModel
- ClienteEnotasRetorno
- BranchGatewayViewModel
- ClienteTransferenciaViewModel
- ClientesAtivosRetornoViewModel
- CofinsEnotasRetorno
- ByteReadOnlyMemory
- ConfiguracaoApiViewModel
- ByteReadOnlySpan
- ContratoEntradasApiViewModel
- CallingConventions
- ContratoFiliaisResumoApiViewModel
- CityViewModel
- CancellationToken
- ContratosCanceladosParcelasApiViewModel
- ContratosCanceladosResumoApiViewModel
- ContratosResumoApiViewModel
- ContratosResumoPaginaVendaViewModel
- ColaboradoresBloqueioAgendaApiViewModel
- ConveniosApiViewModel
- CostCenterApiViewModel
- ConjugadoItemRequestApiViewModel
- Claim
- DadosContratoTrasnferenciaApiViewModel
- ClaimsIdentity
- DadosTrocaContratoApiViewModel
- ClaimsPrincipal
- DebtorChargesViewModel
- DebtorsItensViewModel
- DefaultResponseViewModel
- DiferenciaisApiViewModel
- DifferentialsViewModel
- EFormaContato
- EFormaPagamentoTotem
- EOrigemAgendamento
- EStatusAtividade
- ConnectionInfo
- EStatusAtividadeSessao
- ConstructorInfo
- ETemperatura
- ETipoContrato
- ETipoDocumento
- ETipoGateway
- DropsetItemRequestApiViewModel
- EmployeeApiIntegracaoAtualizacaoViewModel
- EmployeeApiBranchPermissions
- EmployeeApiIntegracaoViewModel
- EmpresasConveniosApiViewModel
- ESubStatus
- EmpresasFiliaisGatewayViewModel
- EmpresasFiliaisOcupacaoViewModel
- ESubStatusApi
- CustomAttributeData
- EnderecoEnotasRetorno
- CustomAttributeNamedArgument
- EnotasRetorno
- CustomAttributeTypedArgument
- EntradasResumoApiViewModel
- EstadoViewModel
- ExperimentalClassResponseViewModel
- FitcoinsResponseViewModel
- FreezeViewModel
- FreteEnotasRetorno
- FuncionariosResumoApiViewModel
- HttpResponseError
- IcmsEnotasRetorno
- ImpostosEnotasRetorno
- InformacoesIndicadosViewModel
- InstallmentViewModel
- ItenEnotasRetorno
- LiberacaoCatracaManualViewModel
- LogTefApiViewModel
- MemberAuthenticateViewModel
- MemberBasicResponsibleViewModel
- MemberBlockUnblockViewModel
- MemberDataViewModel
- MemberMembershipApiViewModel
- MemberNewSaleViewModel
- MemberResponsibleViewModel
- IdMemberResponseViewModel
- MemberServiceViewModel
- MemberTransferViewModel
- ItensBloqueioAgendaApiViewModel
- MembersApiViewModel
- MembersBasicApiViewModel
- MetadadosEnotasRetorno
- MonthDiscountViewModel
- NewSaleViewModel
- NotificationApiViewModel
- MatricularApiViewModel
- EventAttributes
- NotificationProspectApiViewModel
- MatricularConfiguracaoApiViewModel
- EventInfo
- NotificationResponseViewModel
- NovoVoucherViewModel
- FieldAttributes
- PagamentoEnotasRetorno
- FieldInfo
- PayablesApiSubTypesViewModel
- PayablesApiViewModel
- PedidoEnotasRetorno
- PercentualAproximadoTributosEnotasRetorno
- PeriodizacaoApiViewModel
- GenericParameterAttributes
- PisEnotasRetorno
- HostString
- PixPaymentDetailsViewModel
- HttpContext
- PrescricaoTreinoViewModel
- MembersApiResumidoVendaViewModel
- HttpRequest
- ProblemDetails
- HttpResponse
- ProspectApiIntegracaoAtualizacaoViewModel
- ProspectApiIntegracaoViewModel
- ICustomAttributeProvider
- ProspectIdViewModel
- IIdentity
- ProspectResponsavelFinanceiroViewmodel
- IPAddress
- ProspectTransferViewModel
- NeighborhoodViewModel
- IResponseCookies
- ProspectTransferenciaViewModel
- IServiceProvider
- ProspectsResumoApiViewModel
- ISession
- ProtocoloEnotasRetorno
- PublicoAtividadeViewModel
- ReceivablesApiSubTypesViewModel
- ReceivablesApiViewModel
- ReceivablesApiViewModelListGridComQtdeViewModel
- ReceivablesCreditDetails
- IntPtr
- ReceivablesInvoiceApiViewModel
- ProgressivoItemRequestApiViewModel
- ReceivablesMaskReceivedViewModel
- RetornoCatracaViewModel
- KeySizes
- RetornoEntradaManualViewModel
- LayoutKind
- RevenueCenterApiViewModel
- SaleItensViewModel
- SalesItemViewModel
- SalesItemsViewModel
- MatriculaDetalhesApiViewModel
- SalesViewModel
- ProdutoResumoApiViewModel
- ServiceDiscountViewModel
- ServicoAdicionalApiViewModel
- ServicoAnualApiViewModel
- ServicoEnotasRetorno
- ServicosResumoApiViewModel
- RecursosBloqueioAgendaApiViewModel
- MemberInfo
- SimplificadoEnotasRetorno
- SpsProspectsServicosInteresses
- MemberLevelViewModel
- SumaryDebtorsViewModel
- TaxDataViewModel
- MemberParkingViewModel
- TelefoneApiViewModel
- TransferClientResponseViewModel
- TransporteEnotasRetorno
- MemberTypes
- UnavailableSpotsResponseViewModel
- VouchersResumoApiViewModel
- W12UtilsCategoryMembershipViewModel
- SerieItemRequestApiViewModel
- W12UtilsWebhookHeaderViewModel
- SeriePrescricaoRequestApiViewModel
- MethodAttributes
- W12UtilsWebhookViewModel
- MethodBase
- W12UtilzWebHookFilterViewModel
- MethodImplAttributes
- YearDiscountViewModel
- TimeSpan
- MethodInfo
- autorizaEntradaExternoViewModel
- ReverseReceivedResponseViewModel
- retornoAutorizaEntradaExternoViewModel
- MobilePushMultiplaViewModel
- ReverseReceivedViewModel
- MobilePushViewModel
- Module
- ModuleHandle
- SalesViewModelV2
- TreinoPrescricaoRequestApiViewModel
- Oid
- VoucherCriacaoViewModel
- StateViewModel
- ParameterAttributes
- VouchersCodigosViewModel
- ParameterInfo
- VouchersCodigosViewModelListWithQuantityViewModel
- PathString
- PipeReader
- VoucherAtributePublicViewModel
- PipeWriter
- VoucherItemApiViewModel
- PropertyAttributes
- PropertyInfo
- PublicKey
- QueryString
- RuntimeFieldHandle
- RuntimeMethodHandle
- RuntimeTypeHandle
- SafeWaitHandle
- SecurityRuleSet
- Stream
- StringStringKeyValuePair
- StringStringValuesKeyValuePair
- StructLayoutAttribute
- Type
- TypeAttributes
- TypeInfo
- TypeObjectKeyValuePair
- WaitHandle
- WebSocketManager
- X500DistinguishedName
- X509Certificate2
- X509Extension
Add prospects
POST
https://evo-integracao-api.w12app.com.br/api/v1/prospects
Prospects
Adicionar Prospect#
Descrição#
OBS. Disponível para uso com chave de acesso de filial e também com chave de acesso de ADM Geral.
📨 Corpo da Requisição (Request Body)#
| Parâmetro | Tipo | Descrição | Obrigatório |
|---|---|---|---|
| name | string | Nome preferencial do prospect. | Sim |
| lastName | string | Sobrenome preferencial do prospect. | Sim |
| string | E-mail do prospect. | Sim | |
| idBranch | int32 | ID da unidade (filial) associada. | Sim |
| cellphone | string | Número de celular do prospect. | Sim |
| cpf | string | CPF do prospect. | Sim |
| registerName | string | Nome de registro do prospect. | Não |
| registerLastName | string | Sobrenome de registro do prospect. | Não |
| ddi | string | Código DDI do telefone (ex: +55). | Não |
| birthday | date-time | Data de nascimento (formato ISO 8601). | Não |
| gender | string | Gênero do prospect {M, F, P}. | 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 |
| passport | string | Número de passaporte do prospect. | Não |
| rg | string | Número de RG do prospect. | Não |
| address | string | Endereço do prospect. | Não |
| city | string | Cidade do prospect. | Não |
| complement | string | Complemento do endereço. | Não |
| neighborhood | string | Bairro do prospect. | Não |
| idState | int32 | ID do estado (UF). | Não |
| zipCode | string | CEP do prospect. | Não |
| number | string | Número do endereço. | Não |
| tokenGympass | string | Token de integração com Gympass (se aplicável). | Não |
| userTokenGoGood | string | Token de integração com GoGood (se aplicável). | Não |
| additionalFieldName | string | Nome de campo adicional personalizado. | Não |
| additionalFieldValue | string | Valor do campo adicional personalizado. | Não |
| validateCpfDuplication | boolean | Indica se deve validar duplicidade de CPF ao criar o prospect. | Não |
| temperature | number | Temperatura do lead (ex.: score interno). | Não |
| financiallyResponsible | object | Dados do responsável financeiro. Ver mais abaixo. | Não |
| interests | array[int32] | Lista de IDs de interesses do prospect. | Não |
🧩 Estrutura do objeto financiallyResponsible#
| Parâmetro | Tipo | Descrição | Obrigatório |
|---|---|---|---|
| idMember | int32 | ID de membro vinculado como responsável financeiro. | Não |
| name | string | Nome do responsável financeiro. | Não |
| string | E-mail do responsável financeiro. | Não | |
| cpf | string | CPF do responsável financeiro. | Não |
📤 Estrutura da Resposta#
| Parâmetro | Tipo | Descrição |
|---|---|---|
| idProspect | int | Identificador do prospect criado. |
Requisição
Authorization
Basic Auth
Envie suas requisições HTTP com um cabeçalho
Authorization
que contenha a palavra Basic seguida por um espaço e uma string codificada em base64 username:passwordExemplo:
Authorization: Basic *****************or
Parâmetros Bodyapplication/json-patch+json
Exemplo
{
"name": "string",
"email": "string",
"lastName": "string",
"registerName": "string",
"registerLastName": "string",
"usePreferredName": true,
"idBranch": 0,
"ddi": "string",
"cellphone": "string",
"birthday": "2019-08-24T14:15:22.123Z",
"gender": "string",
"visit": 0,
"marketingType": "string",
"notes": "string",
"currentStep": "string",
"cpf": "string",
"validateCpf": true,
"passport": "string",
"rg": "string",
"address": "string",
"city": "string",
"complement": "string",
"neighborhood": "string",
"idState": 0,
"zipCode": "string",
"number": "string",
"tokenGympass": "string",
"userTokenGoGood": "string",
"additionalFieldName": "string",
"additionalFieldValue": "string",
"validateCpfDuplication": true,
"temperature": 1,
"financiallyResponsible": {
"idMember": 0,
"name": "string",
"email": "string",
"cpf": "string"
},
"interests": [
0
]
}Exemplos de Requisição
Shell
JavaScript
Java
Swift
Go
PHP
Python
HTTP
C
C#
Objective-C
Ruby
OCaml
Dart
R
Request Request Example
Shell
JavaScript
Java
Swift
curl --location --request POST 'https://evo-integracao-api.w12app.com.br/api/v1/prospects' \
--header 'Authorization: Basic <encoded-value>' \
--header 'Content-Type: application/json-patch+json' \
--data-raw '{
"name": "string",
"email": "string",
"lastName": "string",
"registerName": "string",
"registerLastName": "string",
"usePreferredName": true,
"idBranch": 0,
"ddi": "string",
"cellphone": "string",
"birthday": "2019-08-24T14:15:22.123Z",
"gender": "string",
"visit": 0,
"marketingType": "string",
"notes": "string",
"currentStep": "string",
"cpf": "string",
"validateCpf": true,
"passport": "string",
"rg": "string",
"address": "string",
"city": "string",
"complement": "string",
"neighborhood": "string",
"idState": 0,
"zipCode": "string",
"number": "string",
"tokenGympass": "string",
"userTokenGoGood": "string",
"additionalFieldName": "string",
"additionalFieldValue": "string",
"validateCpfDuplication": true,
"temperature": 1,
"financiallyResponsible": {
"idMember": 0,
"name": "string",
"email": "string",
"cpf": "string"
},
"interests": [
0
]
}'Respostas
🟢200OK
application/json
Body
Exemplo
{
"idProspect": 0
}🟠400Bad Request
Modificado em 2026-04-01 19:27:56