A SharpSpring possui uma organização de API distinta. Este artigo detalha os métodos listados na API da SharpSpring.
É importante ressaltar que, por serem próprios da estrutura e do código da API, este artigo contém diversos termos em inglês.
Usuários com acesso:
-
Administradores
Informações Adicionais Sobre a API
Este artigo fornece conteúdo específico de método sobre a API da SharpSpring. No entanto, dado o tamanho e o escopo da API, as informações são divididas e contidas em diferentes artigos. Cada artigo foca em uma função específica da API da SharpSpring. Informações adicionais sobre a API podem ser encontradas nos seguintes artigos:
Lista de Métodos
Os seguintes métodos estão disponíveis na API da SharpSpring:
|
Método |
Módulo |
Tabela |
|
createAccounts |
Core |
Account |
|
deleteAccounts |
Core |
Account |
|
getAccount |
Core |
Account |
|
getAccounts |
Core |
Account |
|
getAccountsDateRange |
Core |
Account |
|
updateAccounts |
Core |
Account |
|
createCampaigns |
Core |
Campaign |
|
deleteCampaigns |
Core |
Campaign |
|
getCampaign |
Core |
Campaign |
|
getCampaigns |
Core |
Campaign |
|
getCampaignsDateRange |
Core |
Campaign |
|
updateCampaigns |
Core |
Campaign |
|
getClients |
Core |
Company Profile Managed By |
|
createSendMail |
Core |
CreateSendEmail |
|
createDealStages |
Core |
DealStage |
|
deleteDealStages |
Core |
DealStage |
|
getDealStage |
Core |
DealStage |
|
getDealStages |
Core |
DealStage |
|
getDealStagesDateRange |
Core |
DealStage |
|
createEmail |
Core |
|
|
deleteEmail |
Core |
|
|
getEmail |
Core |
|
|
getEmailListing |
Core |
|
|
updateEmail |
Core |
|
|
deleteScheduleSend |
Core |
EmailJob |
|
getEmailEvents |
Core |
EmailJob |
|
getEmailSendEvents |
Core |
EmailJob |
|
getEmailSendStatus |
Core |
EmailJob |
|
getScheduleSendStatus |
Core |
EmailJob |
|
getScheduleSends |
Core |
EmailJob |
|
getSendCount |
Core |
EmailJob |
|
getEvents |
Core |
Event |
|
createFields |
Core |
Field |
|
deleteFields |
Core |
Field |
|
getFields |
Core |
Field |
|
updateFields |
Core |
Field |
|
getRelatedLeadsByEmail |
Core |
Form Event History |
|
getListTags |
Core |
GetListTags |
|
createLeads |
Core |
Lead |
|
deleteLeads |
Core |
Lead |
|
getLead |
Core |
Lead |
|
getLeads |
Core |
Lead |
|
getLeadsDateRange |
Core |
Lead |
|
subscribeToLeadUpdates |
Core |
Lead |
|
updateLeads |
Core |
Lead |
|
updateLeadsV2 |
Core |
Lead |
|
createList |
Core |
List |
|
deleteList |
Core |
List |
|
getActiveLists |
Core |
List |
|
updateList |
Core |
List |
|
addListMember |
Core |
ListMember |
|
addListMemberEmailAddress |
Core |
ListMember |
|
addListMembers |
Core |
ListMember |
|
addListMembersEmailAddress |
Core |
ListMember |
|
getContactListMemberships |
Core |
ListMember |
|
getEmailSend |
Core |
ListMember |
|
getListMemberships |
Core |
ListMember |
|
removeListMember |
Core |
ListMember |
|
removeListMemberEmailAddress |
Core |
ListMember |
|
removeListMembers |
Core |
ListMember |
|
removeListMembersEmailAddress |
Core |
ListMember |
|
removeListMembersAll |
Core |
ListMembers |
|
CreateOpportunities |
Core |
Opportunity |
|
deleteOpportunities |
Core |
Opportunity |
|
getOpportunities |
Core |
Opportunity |
|
getOpportunitiesDateRange |
Core |
Opportunity |
|
getOpportunity |
Core |
Opportunity |
|
updateOpportunities |
Core |
Opportunity |
|
createOpportunityLeads |
Core |
OpportunityLead |
|
deleteOpportunityLeads |
Core |
OpportunityLead |
|
getOpportunityLead |
Core |
OpportunityLead |
|
getOpportunityLeads |
Core |
OpportunityLead |
|
getOpportunityLeadsDateRange |
Core |
OpportunityLead |
|
getUnsubscribeCategories |
Core |
Unsubscribe Category |
|
getUserProfiles |
Core |
UserProfile |
|
updateAccountSendLimit |
Core |
accountSendLimit |
|
createClient |
Core |
companyProfile |
|
updateClient |
Core |
companyProfileUpdate |
|
disableAccountSending |
Core |
disableAccountSending |
|
enableAccountSending |
Core |
enableAccountSending |
|
logCalls |
Core |
eventHistory |
|
getEmailJobs |
Core |
getemailjob |
|
getLeadListMemberships |
Core |
listLeadMembership |
|
getLeadTimeline |
Core |
leadTimeline |
|
getRemovedListMembers |
Core |
listLeadMember |
|
getListMembers |
Core |
listMembers |
Account
createAccounts
Especifica uma lista de objetos Account para que sejam criados na SharpSpring.
|
|
Nome |
Tipo |
É obrigatório |
|
Parâmetros |
objects |
list<account> |
Obrigatório |
|
|
Nome |
Tipo |
|
Dado de retorno |
creates |
list<createResult> |
deleteAccounts
Especifica uma lista de IDs de Account para que sejam deletadas na SharpSpring.
|
|
Nome |
Tipo |
É obrigatório |
|
Parâmetros |
objects |
list<id> |
Obrigatório |
|
|
Nome |
Tipo |
|
Dado de retorno |
deletes |
list<deleteResult> |
getAccount
Recupera uma única Account por seu ID.
|
|
Nome |
Tipo |
É obrigatório |
Parâmetros |
id |
int |
Obrigatório |
|
|
Nome |
Tipo |
Dado de retorno |
accounts |
list<Account> |
getAccounts
Recupera uma lista de Accounts às quais foi atribuída uma cláusula WHERE, ou recupera todas Accounts se a cláusula WHERE estiver vazia.
|
|
Nome |
Tipo |
É obrigatório |
Parâmetros |
where |
hash
Opcional: id, ownerID |
Obrigatório |
Parâmetros |
limit |
int |
Opcional |
Parâmetros |
offset |
int |
Opcional |
|
|
Nome |
Tipo |
Dado de retorno |
accounts |
list<Account> |
getAccountsDateRange
Recupera uma lista de Accounts que foram criadas ou atualizadas entre dois timestamps, que são marcadores de data e hora. Os timestamps devem ser especificados no formato A-m-d H:i:s.
|
|
Nome |
Tipo |
É obrigatório |
Parâmetros |
startDate |
timestamp |
Obrigatório |
Parâmetros |
endDate |
timestamp |
Obrigatório |
Parâmetros |
timestamp |
string
Obrigatório: create, update Opcional: nenhum |
Obrigatório |
|
|
Nome |
Tipo |
Dado de retorno |
Accounts |
list<Account> |
updateAccounts
Especifica uma lista de objetos Accounts para que sejam atualizados na SharpSpring.
|
|
Nome |
Tipo |
É obrigatório |
Parâmetros |
objects |
list<account> |
Obrigatório |
|
|
Nome |
Tipo |
Dado de retorno |
updates |
list<updateResult> |
Campaign
createCampaigns
Especifica uma lista de objetos Campaign para serem criados na SharpSpring.
|
|
Nome |
Tipo |
É obrigatório |
Parâmetros |
objects |
list<campaign> |
Obrigatório |
|
|
Nome |
Tipo |
Dado de retorno |
creates |
list<createResult> |
deleteCampaigns
Especifica uma lista de IDs de Campaign para serem deletados na SharpSpring.
|
|
Nome |
Tipo |
É obrigatório |
Parâmetros |
objects |
list<id> |
Obrigatório |
|
|
Nome |
Tipo |
Dado de retorno |
deletes |
list<deleteResult> |
getCampaign
Recupera uma única Campaign por seu ID.
|
|
Nome |
Tipo |
É obrigatório |
Parâmetros |
id |
int |
Obrigatório |
|
|
Nome |
Tipo |
Dado de retorno |
campaigns |
list<Campaign> |
getCampaigns
Recupera uma lista de Campaigns às quais foram atribuídas uma cláusula WHERE ou recupera todas as Campaigns se a cláusula WHERE estiver vazia.
|
|
Nome |
Tipo |
É obrigatório |
Parâmetros |
where |
hash
Obrigatório: nenhum Opcional: id, name, campaign |
Obrigatório |
Parâmetros |
limit |
int |
Opcional |
Parâmetros |
offset |
int |
Opcional |
|
|
Nome |
Tipo |
Dado de retorno |
campaigns |
list<Campaign> |
getCampaignsDateRange
Recupera uma lista de Campaigns que foram criadas ou atualizadas entre dois timestamps, que são marcadores de data e hora. Os timestamps devem ser especificados no formato A-m-d H:i:s.
|
|
Nome |
Tipo |
É obrigatório |
Parâmetros |
startDate |
timestamp |
Obrigatório |
Parâmetros |
endDate |
timestamp |
Obrigatório |
Parâmetros |
timestamp |
string
Obrigatório: create, update Opcional: nenhum |
Obrigatório |
|
|
Nome |
Tipo |
Dado de retorno |
Campaigns |
list<Campaign> |
updateCampaigns
Especifica uma lista de objetos Campaign para serem atualizados na SharpSpring.
|
|
Nome |
Tipo |
É obrigatório |
Parâmetros |
objects |
list<campaign> |
Obrigatório |
|
|
Nome |
Tipo |
Dado de retorno |
updates |
list<updateResult> |
Company Profile Managed By
getClients
Obtém uma lista de todas as empresas ativas administradas por sua empresa.
|
|
Nome |
Tipo |
É obrigatório |
Parâmetros |
Nada listado |
Nada listado |
Nada listado |
|
|
Nome |
Tipo |
Dado de retorno |
getAllcompanyProfileManagedBys |
list<Client> |
CreateSendEmail
createSendMail
Envia um e-mail para uma lista ou listas de uma tag específica.
|
|
Nome |
Tipo |
É obrigatório |
Parâmetros |
objects |
list<ScheduleSend> |
Obrigatório |
|
|
Nome |
Tipo |
Dado de retorno |
actions |
list<CreateResult> |
DealStage
createDealStages
Especifica uma lista de objetos DealStage para serem criados na SharpSpring.
|
|
Nome |
Tipo |
É obrigatório |
Parâmetros |
objects |
list<dealStage> |
Obrigatório |
|
|
Nome |
Tipo |
Dado de retorno |
creates |
list<createResult> |
deleteDealStage
Especifica uma lista de IDs de DealStage para serem deletadas na SharpSpring.
|
|
Nome |
Tipo |
É obrigatório |
Parâmetros |
objects |
list<id> |
Obrigatório |
|
|
Nome |
Tipo |
Dado de retorno |
deletes |
list<deleteResult> |
getDealStage
Recupera um único DealStage pelo seu ID.
|
|
Nome |
Tipo |
É obrigatório |
Parâmetros |
id |
int |
Obrigatório |
|
|
Nome |
Tipo |
Dado de retorno |
dealStages |
list<DealStage> |
getDealStages
Recupera uma lista de DealStage às quais foram atribuídas uma cláusula WHERE ou recupera todas as DealStage se a cláusula WHERE estiver vazia.
|
|
Nome |
Tipo |
É obrigatório |
Parâmetros |
where |
hash
Obrigatório: nenhum Opcional: id |
Obrigatório |
Parâmetros |
limit |
int |
Opcional |
Parâmetros |
offset |
int |
Opcional |
|
|
Nome |
Tipo |
Dado de retorno |
dealStages |
list<DealStage> |
getDealStagesDateRange
Recupera uma lista de DealStages que foram criadas ou atualizadas entre dois timestamps, que são marcadores de data e hora. Os timestamps devem ser especificados no formato A-m-d H:i:s.
|
|
Nome |
Tipo |
É obrigatório |
Parâmetros |
startDate |
timestamp |
Obrigatório |
Parâmetros |
endDate |
timestamp |
Obrigatório |
Parâmetros |
timestamp |
string
Obrigatório: create, update Opcional: nenhum |
Obrigatório |
|
|
Nome |
Tipo |
Dado de retorno |
DealStages |
list<DealStage> |
createEmail
Cria um e-mail a partir do HTML.
|
|
Nome |
Tipo |
É obrigatório |
Parâmetros |
objects |
list<Email> |
Obrigatório |
|
|
Nome |
Tipo |
Dado de retorno |
actions |
list<CreateResult> |
deleteEmail
Especifica o ID de um e-mail para ser deletado na SharpSpring.
|
|
Nome |
Tipo |
É obrigatório |
Parâmetros |
objects |
list<id> |
Obrigatório |
|
|
Nome |
Tipo |
Dado de retorno |
actions |
list<DeleteResult> |
getEmail
Retorna os dados HTML do e-mail solicitados.
|
|
Nome |
Tipo |
É obrigatório |
Parâmetros |
id |
int |
Obrigatório |
|
|
Nome |
Tipo |
Dado de retorno |
fields |
Retorna apenas os dados HTML |
getEmailListing
Retorna uma lista de informações de e-mail.
|
|
Nome |
Tipo |
É obrigatório |
Parâmetros |
where |
hash
Obrigatório: nenhum Opcional: id |
Opcional |
Parâmetros |
limit |
int |
Opcional |
Parâmetros |
offset |
int |
Opcional |
|
|
Nome |
Tipo |
Dado de retorno |
fields |
Retorna apenas os dados HTML |
updateEmail
Especifica uma lista de Emails existentes para ser atualizada na SharpSpring. O ID de cada e-mail deve ser passado para cada registro que será atualizado.
|
|
Nome |
Tipo |
É obrigatório |
Parâmetros |
object |
list<Email> |
Obrigatório |
|
|
Nome |
Tipo |
Dado de retorno |
actions |
list<UpdateResult> |
EmailJob
deleteScheduleSend
Deleta um trabalho de e-mail agendado para enviar para uma lista ou um lead.
|
|
Nome |
Tipo |
É obrigatório |
Parâmetros |
jobID |
int |
Obrigatório |
|
|
Nome |
Tipo |
Dado de retorno |
deletes |
list<DeleteResult> |
getEmailEvents
Recupera estatísticas de e-mail por jobID. Como opção, é possível filtrar ao tipo de evento. Os valores autorizados para eventType são clicks, opens, bounces, sends e unsubscribes.
|
|
Nome |
Tipo |
É obrigatório |
Parâmetros |
emailjobID |
int |
Obrigatório |
|
Parâmetros |
eventType |
string |
Obrigatório |
|
|
Nome |
Tipo |
Dado de retorno |
events |
list<EmailEvent> |
getEmailSendEvents
Recupera os envios de e-mail de um determinado trabalho de e-mail.
|
|
Nome |
Tipo |
É obrigatório |
Parâmetros |
sendID |
int |
Obrigatório |
Parâmetros |
eventType |
string [sends, opens, clicks, bounces, spam, unsubscribes] |
Obrigatório |
Parâmetros |
limit |
int |
Obrigatório |
|
Parâmetros |
startingAfter |
int [eventID] |
Opcional |
|
|
Nome |
Tipo |
Dado de retorno |
events |
list<EmailSendEvent> |
|
Dado de retorno |
hasMore |
boolean |
getEmailSendStatus
Obtém um status que determina se um trabalho de e-mail foi enviado ou se está na fila.
|
|
Nome |
Tipo |
É obrigatório |
Parâmetros |
sendID |
int |
Obrigatório |
|
|
Nome |
Tipo |
Dado de retorno |
status |
n/a |
getScheduleSendStatus
Obtém o stauts de envio de um trabalho de e-mail agendado.
|
|
Nome |
Tipo |
É obrigatório |
Parâmetros |
jobID |
int |
Obrigatório |
Parâmetros |
limit |
int |
Opcional |
Parâmetros |
offset |
int |
Opcional |
|
|
Nome |
Tipo |
Dado de retorno |
automationEventQueue |
id, taskID, workflowID, timeProcessed, processed, workflowEventData, sendDuplicate, email {id, companyID, fromEmail, fromName, subject, title}, whoID, whoType, whatID, whatType, createTimestamp |
getScheduleSends
Obtém os trabalhos de e-mail agendados para envio por list, lead, email, ou trabalho.
|
|
Nome |
Tipo |
É obrigatório |
Parâmetros |
where |
hash
Obrigatório: nenhum Opcional: id, campaignName |
Obrigatório |
|
|
Nome |
Tipo |
Dado de retorno |
sends |
list<ScheduleSendQueue> |
getSendCount
Obtém contagens de envios de e-mail por intervalo de tempo e companyID para a agência e contas de clientes.
|
|
Nome |
Tipo |
É obrigatório |
Parâmetros |
fromDate |
timestamp |
Obrigatório |
Parâmetros |
toDate |
timestamp |
Obrigatório |
Parâmetros |
companyID |
int |
Opcional |
|
|
Nome |
Tipo |
Dado de retorno |
sendCounts |
list<companyID, sendCount> |
Event
getEvents
Recupera uma lista de eventos Lead da SharpSpring. Tanto um ID do lead quanto um timestamp podem ser especificados. No caso de especificar-se um timestamp, a API irá recuperar todos os eventos que aconteceram depois do timestamp determinado.
|
|
Nome |
Tipo |
É obrigatório |
Parâmetros |
where |
hash
Obrigatório: nenhum Opcional: leadID, createTimestamp |
Obrigatório |
Parâmetros |
limit |
int |
Opcional |
Parâmetros |
offset |
int |
Opcional |
|
|
Nome |
Tipo |
Dado de retorno |
fields |
list<Event> |
Field
createFields
Especifica uma lista de objetos field - campo - para serem criados na SharpSpring. Cada campo deve, no mínimo, ter uma relationship (tais como opportunity, lead, ou account), dataType (tais como text ou picklist), e label.
|
|
Nome |
Tipo |
É obrigatório |
Parâmetros |
objetcs |
list<Field> |
Obrigatório |
|
|
Nome |
Tipo |
Dado de retorno |
creates |
list<CreateResult> |
deleteFields
Especifica uma lista de fields para serem deletadas na SharpSpring. Apenas campos personalizados podem ser criados. Estes campos são deletados por systemName.
|
|
Nome |
Tipo |
É obrigatório |
Parâmetros |
objetcs |
list<systemName> |
Obrigatório |
|
|
Nome |
Tipo |
Dado de retorno |
deletes |
list<deleteResult> |
getFields
Obtém uma lista de objetos Field. Esta funcionalidade é muito útil para recuperar uma lista de todos os campos personalizados e campos de sistema disponíveis na SharpSpring. Todo resultado terá um systemName, que é a chave que deve ser especificada para atualizar aquele campo para um lead específico.
|
|
Nome |
Tipo |
É obrigatório |
Parâmetros |
where |
hash
Obrigatório: nenhum Opcional: id, label, systemName, isCustom |
Obrigatório |
Parâmetros |
limit |
int |
Opcional |
Parâmetros |
offset |
int |
Opcional |
|
|
Nome |
Tipo |
Dado de retorno |
fields |
list<Field> |
updateFields
Especifica uma lista de Fields existentes para serem atualizados na SharpSpring. O ID de cada campo deve ser passado para cada registro que será atualizado.
|
|
Nome |
Tipo |
É obrigatório |
Parâmetros |
objetcs |
list<Field> |
Obrigatório |
|
|
Nome |
Tipo |
Dado de retorno |
updates |
list<updateResult> |
Form Event History
getRelatedLeadsByEmail
Obtém um conjunto ordenado de registros de Form Event History via um e-mail. Isto é útil para eleminar cópias leads no seu CRM.
|
|
Nome |
Tipo |
É obrigatório |
Parâmetros |
where |
hash
Obrigatório: nenhum Opcional: id, trackingID |
Obrigatório |
Parâmetros |
limit |
int |
Opcional |
Parâmetros |
offset |
int |
Opcional |
|
|
Nome |
Tipo |
Dado de retorno |
fields |
list<FormEventHistory> |
GetListTags
getListTags
Retorna uma lista de tags para listas.
|
|
Nome |
Tipo |
É obrigatório |
Parâmetros |
none |
|
Opcional |
|
|
Nome |
Tipo |
Dado de retorno |
result |
list<listTag> |
Lead
createLeads
Cria uma lista de objetos Lead para serem criados na SharpSpring. Todo objeto lead tem uma hash-key relacionada ao nome de sistema do campo de lead. Se você deseja ativar campos personalizados, primeiro utilize o método de API getFields para obter uma lista de campos personalizados. Para definir um campo personalizado para um lead, utilize o atributo systemName do campo como a chave.
Este método aceita até 500 objetos lead por chamada. No entanto, em instâncias com grandes quantidades de dados de campos personalizados sendo passadas, é melhor separar as solicitações em chamadas menores e mais gerenciáveis, para melhorar o desempenho. Para tanto, 250 objetos de lead devem ser utilizados em casos assim.
|
|
Nome |
Tipo |
É obrigatório |
Parâmetros |
objects |
list<lead> |
Obrigatório |
|
|
Nome |
Tipo |
Dado de retorno |
creates |
list<createResult> |
deleteLeads
Especifica uma lista leads para serem deletados na SharpSpring por ID.
|
|
Nome |
Tipo |
É obrigatório |
Parâmetros |
objects |
list<id> |
Obrigatório |
|
|
Nome |
Tipo |
Dado de retorno |
deletes |
list<deleteResult> |
getLead
Obtém um único Lead por seu ID.
|
|
Nome |
Tipo |
É obrigatório |
Parâmetros |
id |
int |
Obrigatório |
|
|
Nome |
Tipo |
Dado de retorno |
leads |
list<Lead> |
getLeads
Recupera uma lista de Leads aos quais foi atribuída uma cláusula WHERE, ou recupera todos Leads se a cláusula WHERE estiver vazia. Se uma lista é utilizada nos parâmetros, os parâmetros que não forem da lista serão ignorados. No máximo 500 leads serão retornadas com a lista de ID selecionada primeiro. Se a variável FIELDS for especificada, apenas os campos solicitados serão retornados.
|
|
Nome |
Tipo |
É obrigatório |
Parâmetros |
where |
hash
Obrigatório: nenhum Opcional: id, list<id>, emailAddress, list<emailAddress> |
Obrigatório |
Parâmetros |
limit |
int |
Opcional |
Parâmetros |
offset |
int |
Opcional |
|
Parâmetros |
fields |
list<systemName> |
Opcional |
|
|
Nome |
Tipo |
Dado de retorno |
leads |
list<Lead> |
getLeadsDateRange
Recupera uma lista de Leads que foram criadas ou atualizadas entre dois timestamps, que são marcadores de data e hora. Os timestamps devem ser especificados no formato A-m-d H:i:s. Se a variável FIELDS for especificada, apenas os campos solicitados serão retornados.
|
|
Nome |
Tipo |
É obrigatório |
Parâmetros |
startDate |
timestamp |
Obrigatório |
Parâmetros |
endDate |
timestamp |
Obrigatório |
Parâmetros |
timestamp |
string
Obrigatório: create, update Opcional: nenhum |
Obrigatório |
|
Parâmetros |
fields |
list<systemName> |
Opcional |
|
|
Nome |
Tipo |
Dado de retorno |
leads |
list<Lead> |
subscribeToLeadUpdates
Inscreve uma URL para receber atualizações de lead em tempo real. A SharpSpring irá POST (publicar) uma lista de leads atualizados sempre que os leads forem atualizados na aplicação.
|
|
Nome |
Tipo |
É obrigatório |
Parâmetros |
url |
string |
Obrigatório |
|
|
Nome |
Tipo |
Dado de retorno |
success |
boolean |
updateLeads
Especifica uma lista de objetos Lead para serem atualizados na SharpSpring. Todo objeto lead tem uma hash-key relacionada ao nome de sistema do campo de lead. Se você deseja ativar campos personalizados, primeiro utilize o método de API getFields para obter uma lista de campos personalizados. Para definir um campo personalizado para um lead, utilizar o atributo systemName do campo como a chave.
|
|
Nome |
Tipo |
É obrigatório |
Parâmetros |
objects |
list<lead> |
Obrigatório |
|
|
Nome |
Tipo |
Dado de retorno |
updates |
list<updateResult> |
updateLeadsV2
Especifica uma lista de objetos Lead para serem atualizados na SharpSpring. Todo objeto lead tem uma hash-key relacionada ao nome de sistema do campo de lead. Se você deseja ativar campos personalizados, primeiro utilize o método de API getFields para obter uma lista de campos personalizados. Para definir um campo personalizado para um lead, utilizar o atributo systemName do campo como a chave. Isso se difere do updateLeads pois ele retorna o error code 404 caso o ID do lead não exista ou o ID do lead não seja informado e o e-mail do lead não exista.
|
|
Nome |
Tipo |
É obrigatório |
Parâmetros |
objects |
list<lead> |
Obrigatório |
|
|
Nome |
Tipo |
Dado de retorno |
updates |
list<updateResult> |
List
createList
Cria uma lista de envio de e-mails estática.
|
|
Nome |
Tipo |
É obrigatório |
Parâmetros |
name |
string |
Obrigatório |
|
Parâmetros |
description |
string |
Opcional |
|
|
Nome |
Tipo |
Dado de retorno |
status |
boolean<true/false> |
|
Dado de retorno |
id |
int |
deleteList
Especifica uma lista de Lists para ser deletada na SharpSpring por ID.
|
|
Nome |
Tipo |
É obrigatório |
Parâmetros |
objects |
list<id> |
Obrigatório |
|
|
Nome |
Tipo |
Dado de retorno |
deletes |
list<deleteResult> |
getActiveLists
Retorna uma lista de Lists ativas.
|
|
Nome |
Tipo |
É obrigatório |
Parâmetros |
where |
hash
Obrigatório: nenhum Opcional: id |
Obrigatório |
|
Parâmetros |
limit |
int |
Opcional |
|
Parâmetros |
offset |
int |
Opcional |
|
|
Nome |
Tipo |
Dado de retorno |
activeList |
list<List> |
updateList
Atualiza uma lista existente.
|
|
Nome |
Tipo |
É obrigatório |
Parâmetros |
id |
int |
Obrigatório |
|
Parâmetros |
name |
string |
Opcional |
|
Parâmetros |
description |
string |
Opcional |
|
|
Nome |
Tipo |
Dado de retorno |
updates |
list<UpdateResult> |
ListMember
addListMember
Adiciona um lead a uma lista.
|
|
Nome |
Tipo |
É obrigatório |
Parâmetros |
listID |
int |
Obrigatório |
|
Parâmetros |
memberID |
int |
Obrigatório |
|
|
Nome |
Tipo |
Dado de retorno |
creates |
list<createResult> |
addListMemberEmailAddress
Adiciona um membro a uma lista de envio de e-mails utilizando seu endereço de e-mail.
|
|
Nome |
Tipo |
É obrigatório |
Parâmetros |
listID |
int |
Obrigatório |
|
Parâmetros |
emailAddress |
string |
Obrigatório |
|
|
Nome |
Tipo |
Dado de retorno |
create |
list<CreateResult> |
addListMembers
Especifica uma lista de leads pelo ID e listas para gerenciamento em bloco de associados. Cada chamada pode lidar com até 500 associações.
|
|
Nome |
Tipo |
É obrigatório |
Parâmetros |
objects |
list<listID, memberID> |
Obrigatório |
|
|
Nome |
Tipo |
Dado de retorno |
creates |
list<createResult> |
addListMembersEmailAddress
Especifica uma lista de leads pelo endereço de e-mail e listas para gerenciamento em bloco de associados. Cada chamada pode lidar com até 500 associações.
|
|
Nome |
Tipo |
É obrigatório |
Parâmetros |
objects |
list<listID, emailAddress> |
Obrigatório |
|
|
Nome |
Tipo |
Dado de retorno |
creates |
list<createResult> |
getContactListMemberships
Obtém as listas das quais um determinado contato é membro.
|
|
Nome |
Tipo |
É obrigatório |
Parâmetros |
where |
hash
Obrigatório: contactID Opcional: nenhum |
Obrigatório |
|
|
Nome |
Tipo |
Dado de retorno |
listMember |
list<ListMember> |
getEmailSend
Obtém todos os dados agregados para um trabalho de e-mail.
|
|
Nome |
Tipo |
É obrigatório |
Parâmetros |
where |
hash
Obrigatório: sendID Opcional: nenhum |
Obrigatório |
|
|
Nome |
Tipo |
Dado de retorno |
EmailSend |
list<EmailSend> |
getListMemberships
Obtém as listas das quais um determinado contato é membro pelo endereço de e-mail.
|
|
Nome |
Tipo |
É obrigatório |
Parâmetros |
emailAddress |
string |
Obrigatório |
|
|
Nome |
Tipo |
Dado de retorno |
ListMembership |
list<ListMembership> |
removeListMember
Remove um lead de uma lista.
|
|
Nome |
Tipo |
É obrigatório |
Parâmetros |
where |
hash
Obrigatório: listID, contactID Opcional: nenhum |
Obrigatório |
|
|
Nome |
Tipo |
Dado de retorno |
updates |
list<updateResult> |
removeListMemberEmailAddress
Remove um membro de uma lista de envio de e-mails utilizando o endereço de e-mail dele.
|
|
Nome |
Tipo |
É obrigatório |
Parâmetros |
listID |
int |
Obrigatório |
|
Parâmetros |
emailAddress |
string |
Obrigatório |
|
|
Nome |
Tipo |
Dado de retorno |
deletes |
list<deleteResult> |
removeListMembers
Especifica uma lista de leads pelo endereço de e-mail e listas para gerenciamento em bloco de associados. Cada chamada pode lidar com até 500 atualizações.
|
|
Nome |
Tipo |
É obrigatório |
Parâmetros |
objects |
list<listID, memberID> |
Obrigatório |
|
|
Nome |
Tipo |
Dado de retorno |
updates |
list<updateResult> |
removeListMembersEmailAddress
Especifica uma lista de leads pelo endereço de e-mail e listas para gerenciamento em bloco de associados. Cada chamada pode lidar com até 500 atualizações.
|
|
Nome |
Tipo |
É obrigatório |
Parâmetros |
objects |
list<listID, emailAddress> |
Obrigatório |
|
|
Nome |
Tipo |
Dado de retorno |
updates |
list<updateResult> |
ListMembers
removeListMembersAll
Remove todos os membros de uma lista estática que não foram adicionados manualmente. Code é o código HTTP que representa o status da solicitação, e Message é a descrição do código que o acompanha.
|
|
Nome |
Tipo |
É obrigatório |
Parâmetros |
id |
int |
Obrigatório |
|
|
Nome |
Tipo |
Dado de retorno |
result |
code, message |
Opportunity
createOpportunities
Especifica uma lista de objetos Opportunity para serem criados na SharpSpring.
|
|
Nome |
Tipo |
É obrigatório |
Parâmetros |
objects |
list<opportunity> |
Obrigatório |
|
|
Nome |
Tipo |
Dado de retorno |
creates |
list<createResult> |
deleteOpportunities
Especifica uma lista de IDs de Opportunity para serem deletados na SharpSpring.
|
|
Nome |
Tipo |
É obrigatório |
Parâmetros |
objects |
list<id> |
Obrigatório |
|
|
Nome |
Tipo |
Dado de retorno |
deletes |
list<deleteResult> |
getOpportunities
Recupera uma lista de Opportunities às quais foi atribuída uma cláusula WHERE, ou recupera todas Opportunities se a cláusula WHERE estiver vazia.
|
|
Nome |
Tipo |
É obrigatório |
Parâmetros |
where |
hash
Obrigatório: nenhum Opcional: id, ownerID, dealStageID, accountID, campaignID |
Obrigatório |
|
Parâmetros |
limit |
int |
Opcional |
|
Parâmetros |
offset |
int |
Opcional |
|
|
Nome |
Tipo |
Dado de retorno |
opportunity |
list<Opportunity> |
getOpportunitiesDateRange
Recupera uma lista de Opportunities que foram criadas ou atualizadas entre dois timestamps, que são marcadores de data e hora. Os timestamps devem ser especificados no formato A-m-d H:i:s.
|
|
Nome |
Tipo |
É obrigatório |
Parâmetros |
startDate |
timestamp |
Obrigatório |
|
Parâmetros |
endDate |
timestamp |
Obrigatório |
|
Parâmetros |
timestamp |
string
Obrigatório: create, update Opcional: nenhum. |
Obrigatório |
|
|
Nome |
Tipo |
Dado de retorno |
opportunity |
list<Opportunity> |
getOpportunity
Recupera uma única Opportunity por seu ID.
|
|
Nome |
Tipo |
É obrigatório |
Parâmetros |
id |
int |
Obrigatório |
|
|
Nome |
Tipo |
Dado de retorno |
opportunities |
list<Opportunity> |
updateOpportunities
Especifica uma lista de objetos Opportunity para serem atualizados da SharpSpring.
|
|
Nome |
Tipo |
É obrigatório |
Parâmetros |
objects |
list<opportunity> |
Obrigatório |
|
|
Nome |
Tipo |
Dado de retorno |
updates |
list<updateResult> |
OpportunityLead
createOpportunityLeads
Especifica uma lista de objetos OpportunityLead que serão criados na SharpSpring.
|
|
Nome |
Tipo |
É obrigatório |
Parâmetros |
objects |
list<OpportunityLead> |
Obrigatório |
|
|
Nome |
Tipo |
Dado de retorno |
creates |
list<createResult> |
deleteOpportunityLeads
Especifica uma lista de IDs OpportunityLead que serão deletados na SharpSpring.
|
|
Nome |
Tipo |
É obrigatório |
Parâmetros |
objects |
list<id> |
Obrigatório |
|
|
Nome |
Tipo |
Dado de retorno |
deletes |
list<deleteResult> |
getOpportunityLead
Recupera um único OpportunityLead por seu ID.
|
|
Nome |
Tipo |
É obrigatório |
Parâmetros |
id |
int |
Obrigatório |
|
|
Nome |
Tipo |
Dado de retorno |
opportunityLeads |
list<OpportunityLead> |
getOpportunityLeads
Recupera uma lista de objetos OpportunityLead aos quais foi atribuída uma cláusula WHERE, ou recupera todos os objetos OpportunityLead se a cláusula WHERE estiver vazia.
|
|
Nome |
Tipo |
É obrigatório |
Parâmetros |
where |
hash
Obrigatório: nenhum Opcional: id, leadID, opportunityID |
Obrigatório |
|
Parâmetros |
limit |
int |
Opcional |
|
Parâmetros |
offset |
int |
Opcional |
|
|
Nome |
Tipo |
Dado de retorno |
opportunityLeads |
list<OpportunityLeads> |
getOpportunityLeadsDateRange
Recupera uma lista de OpportunityLeads que foram criados ou atualizadas entre dois timestamps, que são marcadores de data e hora. Os timestamps devem ser especificados no formato A-m-d H:i:s.
|
|
Nome |
Tipo |
É obrigatório |
Parâmetros |
startDate |
timestamp |
Obrigatório |
|
Parâmetros |
endDate |
timestamp |
Obrigatório |
|
Parâmetros |
timestamp |
string
Obrigatório: create, update Opcional: nenhum |
Obrigatório |
|
|
Nome |
Tipo |
Dado de retorno |
OpportunityLeads |
list<OpportunityLead> |
Unsubscribe Category
getUnsubscribeCategories
Obtém uma lista de Unsubscribe categories, as Categorias de descadastro.
|
|
Nome |
Tipo |
É obrigatório |
Parâmetros |
none |
|
Opcional |
|
|
Nome |
Tipo |
Dado de retorno |
getAllUnsubscribeCategories |
list<UnsubscribeCategory> |
UserProfile
getUserProfiles
Recupera uma lista de objetos UserProfiles.
|
|
Nome |
Tipo |
É obrigatório |
Parâmetros |
where |
hash
Obrigatório: nenhum Opcional: id, emailAddresses |
Opcional |
|
Parâmetros |
limit |
int |
Opcional |
|
Parâmetros |
offset |
int |
Opcional |
|
|
Nome |
Tipo |
Dado de retorno |
userProfiles |
list<UserProfile> |
accountSendLimit
updateAccountSendLimit
Atualiza o limite de envio de uma subconta.
|
|
Nome |
Tipo |
É obrigatório |
Parâmetros |
clientID |
int |
Obrigatório |
Parâmetros |
emailLimit |
int |
Obrigatório |
|
|
Nome |
Tipo |
Dado de retorno |
updates |
list<UpdateResult> |
companyProfile
createClient
Cria um subcliente para as agências.
country: Este valor tem como base o padrão ISO 3166-1 alpha-2. Alguns exemplos são US, UK e BR.
locale: Opcional. Este valor é responsável pela língua e deve ser um dos seguintes:
-
en_US
-
de_DE
-
es_ES
-
fr_FR
-
it_IT
-
nl_NL
-
pt_PT
-
ro_RO
-
sk_SK
-
tr_TR
salesStartHour: Tem como base o relógio de 24 horas. 00h a 24h.
salesEndHour: Tem como base o relógio de 24 horas. 00h a 24h.
Adicionar um nome de usuário e uma senha irá criar um novo usuário para aquele perfil.
|
|
Nome |
Tipo |
É obrigatório |
Parâmetros |
companyName |
string |
Obrigatório |
|
Parâmetros |
streetAddress |
string |
Opcional |
|
Parâmetros |
zipCode |
string |
Opcional |
Parâmetros |
country |
string |
Opcional |
Parâmetros |
state |
string |
Opcional |
Parâmetros |
city |
string |
Opcional |
Parâmetros |
salesPhone |
string |
Obrigatório |
Parâmetros |
defaultCurrency |
string |
Opcional |
Parâmetros |
locale |
string |
Opcional |
Parâmetros |
salesStartHour |
int |
Opcional |
Parâmetros |
salesEndHour |
int |
Opcional |
Parâmetros |
salesOfficialTimeZone |
string |
Opcional |
Parâmetros |
disallowClientRebrand |
boolean |
Opcional |
Parâmetros |
hideGoogleAdWords |
boolean |
Opcional |
Parâmetros |
displayCallTrackingSettings |
boolean |
Opcional |
Parâmetros |
userEmail |
string |
Opcional |
Parâmetros |
userPassword |
string |
Opcional |
Parâmetros |
userDisplayName |
string |
Opcional |
|
|
Nome |
Tipo |
Dado de retorno |
status |
boolean |
Dado de retorno |
error |
array |
Dado de retorno |
userID |
int |
Dado de retorno |
id |
int |
companyProfileUpdate
updateClient
Atualiza um subcliente para agências.
country: Este valor tem como base o padrão ISO 3166-1 alpha-2. Alguns exemplos são US, UK e BR.
locale: Opcional. Este valor é responsável pela língua e deve ser um dos seguintes:
-
en_US
-
de_DE
-
es_ES
-
fr_FR
-
it_IT
-
nl_NL
-
pt_PT
-
ro_RO
-
sk_SK
-
tr_TR
salesStartHour: Tem como base o relógio de 24 horas. 00h a 24h.
salesEndHour: Tem como base o relógio de 24 horas. 00h a 24h.
|
|
Nome |
Tipo |
É obrigatório |
Parâmetros |
id |
int |
Obrigatório |
|
Parâmetros |
streetAddress |
string |
Opcional |
|
Parâmetros |
zipCode |
string |
Opcional |
Parâmetros |
country |
string |
Opcional |
Parâmetros |
state |
string |
Opcional |
Parâmetros |
city |
string |
Opcional |
Parâmetros |
salesPhone |
string |
Opcional |
Parâmetros |
defaultCurrency |
string |
Opcional |
Parâmetros |
locale |
string |
Opcional |
Parâmetros |
salesStartHour |
int |
Opcional |
Parâmetros |
salesEndHour |
int |
Opcional |
Parâmetros |
salesOfficialTimeZone |
string |
Opcional |
Parâmetros |
disallowClientRebrand |
boolean |
Opcional |
Parâmetros |
hideGoogleAdWords |
boolean |
Opcional |
Parâmetros |
displayCallTrackingSettings |
boolean |
Opcional |
|
|
Nome |
Tipo |
Dado de retorno |
updates |
list<UpdateResult> |
disableAccountSending
disableAccountSending
Desabilita envios por parte de uma subconta.
|
|
Nome |
Tipo |
É obrigatório |
Parâmetros |
clientID |
int |
Obrigatório |
|
|
Nome |
Tipo |
Dado de retorno |
updates |
list<UpdateResult> |
enableAccountSending
enableAccountSending
Habilita envios por parte de uma subconta.
|
|
Nome |
Tipo |
É obrigatório |
Parâmetros |
clientID |
int |
Obrigatório |
|
|
Nome |
Tipo |
Dado de retorno |
updates |
list<UpdateResult> |
eventHistory
logCalls
Registra chamadas com leads. Os timestamps, marcadores de data e hora, devem estar especificados no formato A-m-d H:i:s.
|
|
Nome |
Tipo |
É obrigatório |
Parâmetros |
objects |
list<CallLog> |
Obrigatório |
|
|
Nome |
Tipo |
Dado de retorno |
success |
boolean |
getemailjob
getEmailJobs
Consegue uma lista de trabalhos de email ativos para a conta.
|
|
Nome |
Tipo |
É obrigatório |
Parâmetros |
limit |
string |
Opcional |
|
Parâmetros |
offset |
string |
Opcional |
|
|
Nome |
Tipo |
Dado de retorno |
getAllgetEmailJobs |
list<EmailJob> |
leadListMembership
getLeadListMemberships
Consegue os IDs de lista (list IDs) para cada ID de membro (member ID). Limite máximo de 100 leads por pedido.
|
|
Nome |
Tipo |
É obrigatório |
Parâmetros |
memberIDs |
list<MemberID> |
Obrigatório |
|
|
Nome |
Tipo |
Dado de retorno |
getWhereIns |
list<ListID> |
leadTimeline
getLeadTimeline
Consegue a história de eventos de um lead. Pode ser filtrado ao se estabelecer constraints. Possíveis valores para o parâmetro eventSource:
-
emailOpened
-
emailVisit
-
formSubmit
-
importantPageVisit
|
|
Nome |
Tipo |
É obrigatório |
Parâmetros |
where |
hash
Obrigatório: whoID Opcional: eventName, eventSource, whatType, createTimestamp, whoID |
Obrigatório |
|
|
Nome |
Tipo |
Dado de retorno |
leadTimeline |
list<Event> |
listLeadMember
getRemovedListMembers
Consegue os membros de uma lista que estão removidos (removed), descadastrados (unsubscribed) ou hardbounced. Se nenhuma dessas opções for fornecida via parâmetro flag, o padrão será de removidos (removed).
|
|
Nome |
Tipo |
É obrigatório |
Parâmetros |
where |
hash
Obrigatório: id Opcional: flag |
Obrigatório |
Parâmetros |
limit |
int |
Opcional |
Parâmetros |
offset |
int |
Opcional |
|
|
Nome |
Tipo |
Dado de retorno |
getWherelistLeadMembers |
list<RemovedListMember> |
listMembers
getListMembers
Retorna os membros ativos para uma lista específica.
|
|
Nome |
Tipo |
É obrigatório |
Parâmetros |
where |
hash
Obrigatório: id Opcional: nenhum |
Obrigatório |
Parâmetros |
limit |
int |
Opcional |
Parâmetros |
offset |
int |
Opcional |
|
|
Nome |
Tipo |
Dado de retorno |
fields |
list<List> |
Comentários
0 comentário
Artigo fechado para comentários.