CRM
Corresponde à aba CRM, na tela Configurações do módulo Administrativo. Cada seção abaixo é um cartão da aba: uma lista de opções do cliente, usada pelo módulo CRM nos leads e nas interações comerciais. O uso dessas opções é descrito no próprio módulo CRM.
Os itens destas listas são identificados pelo id numérico, e não pelo uuid. Os
endpoints seguem o mesmo padrão em todas as seções:
GETlista os itens, comsearch, ordenação e paginação.POSTcadastra um item, com um único campo obrigatório.PUTeDELETEcom{id}alteram e apagam um item. A exclusão é lógica. A consulta poridestá indicada em cada seção onde existe.
Cada seção traz a tabela de endpoints e o detalhe apenas do que é específico do cartão.
Meios de contato
Cadastra os meios pelos quais uma interação é registrada, por exemplo telefone, WhatsApp, e-mail ou visita.
| Método | Caminho | Descrição |
|---|---|---|
| GET | /administrative/settings/crm/means-contacts | Lista os meios de contato |
| POST | /administrative/settings/crm/means-contacts | Cadastra um meio de contato |
| GET | /administrative/settings/crm/means-contacts/{id} | Consulta um meio de contato |
| PUT | /administrative/settings/crm/means-contacts/{id} | Altera um meio de contato |
| DELETE | /administrative/settings/crm/means-contacts/{id} | Apaga um meio de contato |
GET /administrative/settings/crm/means-contacts
Parâmetros de URL: search (busca pelo meio), columnName, orderData,
per_page e page.
Resposta (200): lista de itens, direta ou paginada. Campos: id e mean_contact.
POST /administrative/settings/crm/means-contacts
Corpo (JSON)
| Campo | Obrigatório | Tipo | Descrição |
|---|---|---|---|
| mean_contact | Sim | Texto | Nome do meio de contato |
Resposta (201): o item criado, com o id.
Consultar, alterar e apagar
- GET
/administrative/settings/crm/means-contacts/{id}: devolve o item peloid. - PUT
/administrative/settings/crm/means-contacts/{id}: corpo commean_contact(Sim, texto). Resposta (200): o item alterado. - DELETE
/administrative/settings/crm/means-contacts/{id}: resposta (200), sem conteúdo relevante (null).
Motivos
Cadastra os motivos de uma interação, por exemplo cotação, cobrança ou pós-venda.
| Método | Caminho | Descrição |
|---|---|---|
| GET | /administrative/settings/crm/motives | Lista os motivos |
| POST | /administrative/settings/crm/motives | Cadastra um motivo |
| GET | /administrative/settings/crm/motives/{id} | Consulta um motivo |
| PUT | /administrative/settings/crm/motives/{id} | Altera um motivo |
| DELETE | /administrative/settings/crm/motives/{id} | Apaga um motivo |
GET /administrative/settings/crm/motives
Parâmetros de URL: search (busca pelo motivo), columnName, orderData,
per_page e page.
Resposta (200): lista de itens. Campos: id e motives.
POST /administrative/settings/crm/motives
Corpo (JSON)
| Campo | Obrigatório | Tipo | Descrição |
|---|---|---|---|
| motives | Sim | Texto | Nome do motivo |
Resposta (201): o item criado, com o id.
Consultar, alterar e apagar
- GET
/administrative/settings/crm/motives/{id}: devolve o item peloid. - PUT
/administrative/settings/crm/motives/{id}: corpo commotives(Sim, texto). Resposta (200): o item alterado. - DELETE
/administrative/settings/crm/motives/{id}: resposta (200), sem conteúdo relevante (null).
Procedência de alunos
Cadastra a origem de um lead de aluno. É obrigatória ao cadastrar um lead de aluno no CRM, por isso é preciso ter pelo menos uma procedência cadastrada.
| Método | Caminho | Descrição |
|---|---|---|
| GET | /administrative/settings/crm/provenance | Lista as procedências de alunos |
| POST | /administrative/settings/crm/provenance | Cadastra uma procedência de aluno |
| PUT | /administrative/settings/crm/provenance/{id} | Altera uma procedência de aluno |
| DELETE | /administrative/settings/crm/provenance/{id} | Apaga uma procedência de aluno |
GET /administrative/settings/crm/provenance
Parâmetros de URL: search (busca pela procedência), columnName, orderData,
per_page e page.
Resposta (200): lista de itens. Campos: id e provenance.
POST /administrative/settings/crm/provenance
Corpo (JSON)
| Campo | Obrigatório | Tipo | Descrição |
|---|---|---|---|
| provenance | Sim | Texto | Nome da procedência |
Resposta (201): o item criado, com o id.
Consultar, alterar e apagar
- PUT
/administrative/settings/crm/provenance/{id}: corpo comprovenance(Sim, texto). Resposta (200): o item alterado. - DELETE
/administrative/settings/crm/provenance/{id}: resposta (200), sem conteúdo relevante (null).
Procedência de lead de empresas
Cadastra a origem de um lead de empresa.
| Método | Caminho | Descrição |
|---|---|---|
| GET | /administrative/settings/crm/business-leads-provenances | Lista as procedências de leads de empresas |
| POST | /administrative/settings/crm/business-leads-provenances | Cadastra uma procedência de lead de empresa |
| GET | /administrative/settings/crm/business-leads-provenances/{id} | Consulta uma procedência de lead de empresa |
| PUT | /administrative/settings/crm/business-leads-provenances/{id} | Altera uma procedência de lead de empresa |
| DELETE | /administrative/settings/crm/business-leads-provenances/{id} | Apaga uma procedência de lead de empresa |
GET /administrative/settings/crm/business-leads-provenances
Parâmetros de URL: search (busca pela procedência), columnName, orderData,
per_page e page.
Resposta (200): lista de itens. Campos: id e provenance.
POST /administrative/settings/crm/business-leads-provenances
Corpo (JSON)
| Campo | Obrigatório | Tipo | Descrição |
|---|---|---|---|
| provenance | Sim | Texto | Nome da procedência |
Resposta (201): o item criado, com o id.
Consultar, alterar e apagar
- GET
/administrative/settings/crm/business-leads-provenances/{id}: devolve o item peloid. - PUT
/administrative/settings/crm/business-leads-provenances/{id}: corpo comprovenance(Sim, texto). Resposta (200): o item alterado. - DELETE
/administrative/settings/crm/business-leads-provenances/{id}: resposta (200), sem conteúdo relevante (null).
Status de lead de empresas
Cadastra as etapas de acompanhamento de um lead de empresa, por exemplo novo, em contato ou proposta enviada.
| Método | Caminho | Descrição |
|---|---|---|
| GET | /administrative/settings/crm/business-leads-statuses | Lista os status de leads de empresas |
| POST | /administrative/settings/crm/business-leads-statuses | Cadastra um status de lead de empresa |
| GET | /administrative/settings/crm/business-leads-statuses/{id} | Consulta um status de lead de empresa |
| PUT | /administrative/settings/crm/business-leads-statuses/{id} | Altera um status de lead de empresa |
| DELETE | /administrative/settings/crm/business-leads-statuses/{id} | Apaga um status de lead de empresa |
GET /administrative/settings/crm/business-leads-statuses
Parâmetros de URL: search (busca pelo status), columnName, orderData,
per_page e page.
Resposta (200): lista de itens. Campos: id e status.
POST /administrative/settings/crm/business-leads-statuses
Corpo (JSON)
| Campo | Obrigatório | Tipo | Descrição |
|---|---|---|---|
| status | Sim | Texto | Nome do status |
Resposta (201): o item criado, com o id.
Consultar, alterar e apagar
- GET
/administrative/settings/crm/business-leads-statuses/{id}: devolve o item peloid. - PUT
/administrative/settings/crm/business-leads-statuses/{id}: corpo comstatus(Sim, texto). Resposta (200): o item alterado. - DELETE
/administrative/settings/crm/business-leads-statuses/{id}: resposta (200), sem conteúdo relevante (null).
Status de lead de alunos
Cadastra a situação de um lead de aluno, por exemplo interessado ou matriculado.
| Método | Caminho | Descrição |
|---|---|---|
| GET | /administrative/settings/crm/students-leads-situations | Lista as situações de leads de alunos |
| POST | /administrative/settings/crm/students-leads-situations | Cadastra uma situação de lead de aluno |
| PUT | /administrative/settings/crm/students-leads-situations/{id} | Altera uma situação de lead de aluno |
| DELETE | /administrative/settings/crm/students-leads-situations/{id} | Apaga uma situação de lead de aluno |
GET /administrative/settings/crm/students-leads-situations
Parâmetros de URL: search (busca pela situação), columnName, orderData,
per_page e page.
Resposta (200): lista de itens. Campos: id e situation.
POST /administrative/settings/crm/students-leads-situations
Corpo (JSON)
| Campo | Obrigatório | Tipo | Descrição |
|---|---|---|---|
| situation | Sim | Texto | Nome da situação |
Resposta (201): o item criado, com o id.
Consultar, alterar e apagar
- PUT
/administrative/settings/crm/students-leads-situations/{id}: corpo comsituation(Sim, texto). Resposta (200): o item alterado. - DELETE
/administrative/settings/crm/students-leads-situations/{id}: resposta (200), sem conteúdo relevante (null).