voltar

API Referências: Newsletter | Consultar

post /api/Newsletter/Consultar?token=[SEU-TOKEN-SECRETO]&json=[JSON]

Request

Querystring parameters names Type
token string required
json

{
     Hash: varchar,
}

 json required

Response


HttpResponse: OK
Property Type Default response
Status string ok
Code int 200
Success boolean true
Data

array json
{
     [
          AcessoLiberado: text,
          Alteracao: datetime,
          Assunto: string,
          Autonumeracao: int,
          AutonumeracaoEmpresa: int,
          Cadastro: datetime,
          Categoria: int,
          Empresa: uniqueidentifier,
          Hash: uniqueidentifier,
          Mensagem: text,
          Notificavel: bit,
          ObservacoesAdicionais: text,
          Privado: bit,
          Titulo: string,
          UsuarioAlteracao: uniqueidentifier,
          UsuarioAlteracaoDescricao: string,
          UsuarioAlteracaoEmail: string,
          UsuarioCriacao: uniqueidentifier,
          UsuarioCriacaoDescricao: string,
          UsuarioCriacaoEmail: string,
     ]
}

HttpResponse: Error
Property Type Default response
Status string error
Code int 500
Success boolean false
Data array json null

HttpResponse: Unauthorized
Property Type Default response
Status string error
Code int 401
Success boolean false
Data array json null
Message string Invalid token

API Referências: Newsletter | Excluir

post /api/Newsletter/Excluir?token=[SEU-TOKEN-SECRETO]&Hash=[Hash]

Request

Querystring parameters names Type
token string required
Hash guid required

Response


HttpResponse: OK
Property Type Default response
Status string ok
Code int 200
Success boolean true
Data

array json null

HttpResponse: Error
Property Type Default response
Status string error
Code int 500
Success boolean false
Data array json null

HttpResponse: Unauthorized
Property Type Default response
Status string error
Code int 401
Success boolean false
Data array json null
Message string Invalid token

API Referências: Newsletter | Listar

post /api/Newsletter/Listar?token=[SEU-TOKEN-SECRETO]

Request

Querystring parameters names Type
token string required

Response


HttpResponse: OK
Property Type Default response
Status string ok
Code int 200
Success boolean true
Data

array json
{
     [
          AcessoLiberado: text,
          Alteracao: datetime,
          Assunto: string,
          Autonumeracao: int,
          AutonumeracaoEmpresa: int,
          Cadastro: datetime,
          Categoria: int,
          Empresa: uniqueidentifier,
          Hash: uniqueidentifier,
          Mensagem: text,
          Notificavel: bit,
          ObservacoesAdicionais: text,
          Privado: bit,
          Titulo: string,
          UsuarioAlteracao: uniqueidentifier,
          UsuarioCriacao: uniqueidentifier,
     ]
}

HttpResponse: Error
Property Type Default response
Status string error
Code int 500
Success boolean false
Data array json null

HttpResponse: Unauthorized
Property Type Default response
Status string error
Code int 401
Success boolean false
Data array json null
Message string Invalid token

API Referências: Newsletter | Salvar

post /api/Newsletter/Salvar?token=[SEU-TOKEN-SECRETO]&json=[JSON]

Request

Querystring parameters names Type
token string required
json

{
     AcessoLiberado: text,
     Assunto: varchar,
     CamposAtualizados: nvarchar,
     Categoria: int,
     ConsultarPorCampo: varchar,
     Empresa: varchar,
     Hash: varchar,
     HashAplicado: uniqueidentifier,
     Mensagem: text,
     Modo: varchar,
     Notificavel: bit,
     ObservacoesAdicionais: text,
     Privado: bit,
     RetornarDataSet: bit,
     Titulo: varchar,
     UsuarioAlteracao: uniqueidentifier,
     UsuarioCriacao: uniqueidentifier,
     ValorConsultaPorCampo: varchar,
}

 json required

Response


HttpResponse: OK
Property Type Default response
Status string ok
Code int 200
Success boolean true
Data

array json Consultar: https://api.tempbox.com.br/referencias/newsletter?key=Consultar

HttpResponse: Error
Property Type Default response
Status string error
Code int 500
Success boolean false
Data array json null

HttpResponse: Unauthorized
Property Type Default response
Status string error
Code int 401
Success boolean false
Data array json null
Message string Invalid token

API Referências: Newsletter | CriarOportunidade

post /api/Newsletter/CriarOportunidade?token=[SEU-TOKEN-SECRETO]&json=[JSON]

Request

Querystring parameters names Type
token string required
json

{
     Email: varchar,
     Empresa: varchar,
     Notificavel: bit,
}

 json required

Response


HttpResponse: OK
Property Type Default response
Status string ok
Code int 200
Success boolean true
Data

array json null

HttpResponse: Error
Property Type Default response
Status string error
Code int 500
Success boolean false
Data array json null

HttpResponse: Unauthorized
Property Type Default response
Status string error
Code int 401
Success boolean false
Data array json null
Message string Invalid token

API Referências: Newsletter | EmailsSelecionados

post /api/Newsletter/EmailsSelecionados?token=[SEU-TOKEN-SECRETO]&json=[JSON]

Request

Querystring parameters names Type
token string required
json

{
     emails_listas: nvarchar,
     IdEmpresa: varchar,
     NewsletterLojaParceiro: int,
     TodasListas: bit,
     TodosAssinantes: bit,
     TodosClientesAtivos: bit,
     TodosClientesInativos: bit,
}

 json required

Response


HttpResponse: OK
Property Type Default response
Status string ok
Code int 200
Success boolean true
Data

array json null

HttpResponse: Error
Property Type Default response
Status string error
Code int 500
Success boolean false
Data array json null

HttpResponse: Unauthorized
Property Type Default response
Status string error
Code int 401
Success boolean false
Data array json null
Message string Invalid token

API Referências: Newsletter | ListagemDisponivel

post /api/Newsletter/ListagemDisponivel?token=[SEU-TOKEN-SECRETO]&json=[JSON]

Request

Querystring parameters names Type
token string required
json

{
     IdEmpresa: varchar,
     Tipo: varchar,
}

 json required

Response


HttpResponse: OK
Property Type Default response
Status string ok
Code int 200
Success boolean true
Data

array json null

HttpResponse: Error
Property Type Default response
Status string error
Code int 500
Success boolean false
Data array json null

HttpResponse: Unauthorized
Property Type Default response
Status string error
Code int 401
Success boolean false
Data array json null
Message string Invalid token

API Referências: Newsletter | ListarAssinaturasAutorizadas

post /api/Newsletter/ListarAssinaturasAutorizadas?token=[SEU-TOKEN-SECRETO]&json=[JSON]

Request

Querystring parameters names Type
token string required
json

{
     apenas_clientes: bit,
     IdLoja: varchar,
}

 json required

Response


HttpResponse: OK
Property Type Default response
Status string ok
Code int 200
Success boolean true
Data

array json null

HttpResponse: Error
Property Type Default response
Status string error
Code int 500
Success boolean false
Data array json null

HttpResponse: Unauthorized
Property Type Default response
Status string error
Code int 401
Success boolean false
Data array json null
Message string Invalid token

API Referências: Newsletter | ListarAssinaturasNaoAutorizadas

post /api/Newsletter/ListarAssinaturasNaoAutorizadas?token=[SEU-TOKEN-SECRETO]&json=[JSON]

Request

Querystring parameters names Type
token string required
json

{
     apenas_clientes: bit,
     IdLoja: varchar,
}

 json required

Response


HttpResponse: OK
Property Type Default response
Status string ok
Code int 200
Success boolean true
Data

array json null

HttpResponse: Error
Property Type Default response
Status string error
Code int 500
Success boolean false
Data array json null

HttpResponse: Unauthorized
Property Type Default response
Status string error
Code int 401
Success boolean false
Data array json null
Message string Invalid token

API Referências: Newsletter | ListarRelatorioPrincipal

post /api/Newsletter/ListarRelatorioPrincipal?token=[SEU-TOKEN-SECRETO]&json=[JSON]

Request

Querystring parameters names Type
token string required
json

{
     Empresa: varchar,
     Usuario: varchar,
}

 json required

Response


HttpResponse: OK
Property Type Default response
Status string ok
Code int 200
Success boolean true
Data

array json
{
     [
          AutonumeracaoEmpresa: int,
          Hash: uniqueidentifier,
          Newsletter: uniqueidentifier,
          Titulo: string,
     ]
}

HttpResponse: Error
Property Type Default response
Status string error
Code int 500
Success boolean false
Data array json null

HttpResponse: Unauthorized
Property Type Default response
Status string error
Code int 401
Success boolean false
Data array json null
Message string Invalid token

API Referências: Newsletter | QtdEmailsEnviadosNormalizacao

post /api/Newsletter/QtdEmailsEnviadosNormalizacao?token=[SEU-TOKEN-SECRETO]&json=[JSON]

Request

Querystring parameters names Type
token string required
json

Obs: QtdEmailsEnviadosNormalizacao não possui parâmetros. Logo, o parâmetro json pode ser enviado sem valor.
json required

Response


HttpResponse: OK
Property Type Default response
Status string ok
Code int 200
Success boolean true
Data

array json null

HttpResponse: Error
Property Type Default response
Status string error
Code int 500
Success boolean false
Data array json null

HttpResponse: Unauthorized
Property Type Default response
Status string error
Code int 401
Success boolean false
Data array json null
Message string Invalid token

API Referências: Newsletter | QuantidadeEmailsEnviados

post /api/Newsletter/QuantidadeEmailsEnviados?token=[SEU-TOKEN-SECRETO]&json=[JSON]

Request

Querystring parameters names Type
token string required
json

{
     IdLoteNewsletter: varchar,
}

 json required

Response


HttpResponse: OK
Property Type Default response
Status string ok
Code int 200
Success boolean true
Data

array json null

HttpResponse: Error
Property Type Default response
Status string error
Code int 500
Success boolean false
Data array json null

HttpResponse: Unauthorized
Property Type Default response
Status string error
Code int 401
Success boolean false
Data array json null
Message string Invalid token