A SharpSpring possui uma organização da API distinta, cujas diferentes partes são detalhadas neste artigo.

Schema

A organização geral da API da SharpSpring é a seguinte:

Módulo Principal (Core Module)

Funcionalidade principal da API do CRM SharpSpring.

Account

Uma conta é uma organização ou pessoa associada a uma oportunidade.

ActiveListMember

Possui informações de leads de membros ativos que pertencem a uma lista específica.

Campaign

Uma campanha é um projeto de marketing que é monitorado na SharpSpring.

Client

Possui informações sobre as instâncias de agência gerenciadas pela instância do parceiro.

CreateResult

Possui informações sobre o sucesso de uma operação de criação, um array de eventuais erros associados à operação e o ID do novo registro criado.

DealStage

Estágio do negócio é um estado personalizado para a sua pipeline de oportunidades. A medida em que a oportunidade evolui, o estágio é alterado, até que a oportunidade é finalmente ganha ou perdida.

DeleteResult

Possui informações sobre o sucesso de uma operação de delete. Também, um array de eventuais erros associados à operação.

Email

E-mails HTML criados na SharpSpring.

EmailEvent

Possui informações sobre ações particulares do lead, em e-mails específicos enviados através de um trabalho de e-mail.

EmailJob

Associa dados de um jobID com emailIDs e recipientIDs.

EmailListing

Possui informações sobre um grupo de e-mails, incluindo o ID, HTML conteúdo, assunto e imagem em miniatura.

EmailSend

Possui informações sobre trabalhos de e-mail específicos, tais como métricas de abertura, cliques e métricas de cancelamento de assinatura.

EmailSendEvent

Possui informações sobre as ações de um lead relacionadas a um trabalho de e-mail.

Event

Possui informações relacionadas aos eventos de usuários da SharpSpring, similar à Vida do Lead.

Field

Possui metadados de um campo da SharpSpring, tanto campos de leads quanto de oportunidades. O systemName é a chave que pode ser especificada em qualquer POST, para criar ou atualizar um objeto.

FormEventHistory

Vincula emailAddresses a trackingIDs, sendo útil para remover contatos duplicados no CRM.

Lead

Um lead é um contato que possui interesse em seu produto. A medida que o lead avança no pipeline, o seu status muda de não qualificado para qualificado. Um lead pode ser convertido em contato, oportunidade e conta.

Caso você deseja atualizar campos customizados de um lead, especifique o systemName do campo como chave no objeto do lead. Para obter uma lista de nomes do sistema, primeiro recupere membros da tabela Campo.

List

Público segmentado de leads na SharpSpring.

ListMember

Tabela de mapeamento que relaciona leads da SharpSpring a listas das quais eles são membros.

ListMembership

Mostra, por ID, todas as listas das quais um lead é membro e quando o lead foi adicionado às listas.

ListTag

Uma tabela de todas as tags de listas de uma instância da SharpSpring. Tags de listas são usadas para agrupar listas similares, agregando envios de listas, automações e relatórios.

Opportunity

Uma oportunidade representa um negócio em potencial, que possui um valor esperado. Uma oportunidade pode ser associada a um lead, a uma conta ou a uma campanha.

OpportunityLead

Tabela de mapeamento que representa a associação entre uma oportunidade e um lead. Cada oportunidade na SharpSpring pode ser composta de diversos leads.

RemovedListMember

Tabela contendo informações sobre leads removidos de uma lista específica.

ScheduleSend

Um envio de e-mail que está agendado para ser realizado na SharpSpring. Uma listID ou uma listTagID precisa ser especificada. O envio deve ser imediato ou agendado para uma data futura a ser especificada.

ScheduleSendQueue

Possui informações sobre envio de trabalhos de e-mail, na fila de eventos agendados.

UnsubscribeCategory

Consiste nas diferentes categorizações de e-mail que os usuários da SharpSpring podem realizar. Também, nas categorias de cancelamento de assinatura (unsubscribe) que os destinatários podem escolher.

UpdateResult

Possui informações sobre o sucesso de uma operação de update. Também, um array de eventuais erros associados à operação.

UserProfile

Consiste em contas de usuários da SharpSpring. O ID pode ser utilizado no campo proprietário do lead, na tabela do lead, tanto quanto na tabela de oportunidade.

Encontrou sua resposta?