Campanhas
  1. Parâmetros da Campanha
Campanhas
  • CRMALL - Hosts
  • Campanhas
    • Autorização
      • Autorização
    • Documentos
      • Fluxo Geral - Integração para Envio e Processamento de Documentos
      • Envio de documentos por imagem
      • Envio de documentos por código eletrônico
      • Lista de documentos
      • Detalhes de um documento
    • Listagem de Campanhas
      • Listagem de Campanhas
    • Parâmetros da Campanha
      • Parâmetros da Campanha
        GET
    • Prizor SDK Web
      • Gerar URL
    • Transbordo de Notas
      • Transbordo de Notas
      • Recuperar mensagens da fila SQS
  1. Parâmetros da Campanha

Parâmetros da Campanha

GET
/v3/campaign/{campaignId}
Retorna os parâmetros de uma campanha.

Requisição

Authorization
Adicionar o parâmetro
Authorization
a Cabeçalhos
, cujo valor é concatenar o Token após o Bearer.
Exemplo:
Authorization: Bearer ********************
Parâmetros Path
campaignId
integer 
requerido
ID da campanha
Exemplo:
1234

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 GET '/v3/campaign/1234'

Respostas

🟢200Success
application/json
Body
status
string 
requerido
code
integer 
requerido
error
string 
requerido
data
object 
requerido
id
integer 
requerido
ID da campanha.
title
string 
requerido
Nome da campanha.
hashtag
string 
requerido
Hashtag definida para a campanha.
banner
string 
requerido
URI do banner da campanha.
startDate
string 
requerido
Data de início da campanha.
Exemplo:
2025-12-25T00:00:00-03:00
endDate
string 
requerido
Data de término da campanha.
Exemplo:
2025-12-30T00:00:00-03:00
description
string 
requerido
Mensagem para campanha ativa.
endDescription
string 
requerido
Mensagem para campanha encerrada.
termsLink
string 
requerido
URI dos termos da campanha.
authorizationNumber
string 
requerido
Número de autorização.
question
string 
requerido
Pergunta para o usuário responder.
questionPositiveAnswer
string 
requerido
Resposta positiva.
questionNegativeAnswer
string 
requerido
Resposta negativa.
termAcceptanceWhen
string 
requerido
termAcceptance
string 
requerido
inputTypesEnum
integer 
deprecated
inputTypes
array[string]
requerido
Tipos de documentos aceitos.
Valores permitidos:
receiptnfenfcemanualtoken
typeEnum
integer 
deprecated
type
array[string]
requerido
Tipo da campanha.
Valores permitidos:
coupomprizeGivingunique_bidlotteryhintsealeddream_treestamp
onlyAgeOfMajority
boolean 
requerido
Informa se restringe a participação apenas maiores de idade.
onlyFromState
string 
requerido
Informa se restrige a participação a algum estado.
validateBirthdateLogin
boolean 
requerido
protocolEndMessage
string 
requerido
Mensagem de retorno para o usuário quando a nota é enviada.
benefitMessages
array [object {3}] 
requerido
Informações dos benefícios.
hasSellerIncentive
enum<string> 
requerido
Informa se a campanha tem incentivo ao vendedor.
Valores permitidos:
noneinvoiceOnlyelectronicInvoiceOnlyall
hasSurvey
boolean 
requerido
Informa se a pesquisa está habilitada.
participating
boolean 
requerido
ended
boolean 
requerido
isCampaignTest
boolean 
requerido
Informa se é uma campanha de teste.
checkinGroup
integer 
requerido
Informa o grupo do Checkin.
partner
object 
requerido
Informações do parceiro.
crmall
object 
requerido
API do 4C da campanha.
baseUnica
object 
requerido
API da Base Única da campanha.
personTypeAllowed
string 
requerido
Tipo de pesoa (Física / Jurídica) aceita para a campanha.
hasConsent
boolean 
requerido
allowStartWithLoyaltyCode
boolean 
requerido
personAuthenticationPersistentToken
boolean 
requerido
allowDocumentListAtEndedCampaign
boolean 
requerido
prizorGreenButton
boolean 
requerido
showNewCam
boolean 
requerido
Habilitar novo tipo de acesso à câmera do Prizor App.
brandCampaign
object 
requerido
Campanha de marcas.
prizorCustomText
string 
requerido
Texto personalizado para Prizor App.
prizorAppCameraEnabled
boolean 
requerido
Habilitar câmera no Prizor App.
sellerIncentive
object  | null 
requerido
Incentivo ao vendedor.
support
object 
requerido
Informações de contato com suporte.
prizorKioskUnlockByTouch
string 
requerido
prizorKioskUnlockByQRCode
string 
requerido
personAuthenticationType
array[string]
requerido
Exemplo
{
    "status": "string",
    "code": 0,
    "error": "string",
    "data": {
        "id": 0,
        "title": "string",
        "hashtag": "string",
        "banner": "string",
        "startDate": "2025-12-25T00:00:00-03:00",
        "endDate": "2025-12-30T00:00:00-03:00",
        "description": "string",
        "endDescription": "string",
        "termsLink": "string",
        "authorizationNumber": "string",
        "question": "string",
        "questionPositiveAnswer": "string",
        "questionNegativeAnswer": "string",
        "termAcceptanceWhen": "string",
        "termAcceptance": "string",
        "inputTypesEnum": 0,
        "inputTypes": [
            "receipt"
        ],
        "typeEnum": 0,
        "type": [
            "coupom"
        ],
        "onlyAgeOfMajority": true,
        "onlyFromState": "string",
        "validateBirthdateLogin": true,
        "protocolEndMessage": "string",
        "benefitMessages": [
            {
                "typeEnum": 0,
                "type": "string",
                "message": "string"
            }
        ],
        "hasSellerIncentive": "none",
        "hasSurvey": true,
        "participating": true,
        "ended": true,
        "isCampaignTest": true,
        "checkinGroup": 0,
        "partner": {
            "id": 0,
            "companyName": "string",
            "logo": "string",
            "document": "string",
            "phone": "string",
            "email": "string",
            "address": {
                "zipCode": "string",
                "street": "string",
                "number": "string",
                "neighborhood": "string",
                "city": "string",
                "state": "string",
                "lat": "string",
                "long": "string",
                "distance": "string"
            }
        },
        "crmall": {
            "url": "string",
            "credentials": "string",
            "underMaintenance": true
        },
        "baseUnica": {
            "url": "string",
            "credentials": "string"
        },
        "personTypeAllowed": "string",
        "hasConsent": true,
        "allowStartWithLoyaltyCode": true,
        "personAuthenticationPersistentToken": true,
        "allowDocumentListAtEndedCampaign": true,
        "prizorGreenButton": true,
        "showNewCam": true,
        "brandCampaign": {
            "enabled": true,
            "link": "string",
            "description": "string"
        },
        "prizorCustomText": "string",
        "prizorAppCameraEnabled": true,
        "sellerIncentive": {
            "type": "invoiceOnly",
            "question": "string",
            "instruction": "string",
            "fieldType": "string",
            "fieldLength": "string",
            "image": "string"
        },
        "support": {
            "title": "string",
            "info": "string",
            "email": "string",
            "phone1link": "string",
            "phone1display": "string",
            "phone2link": "string",
            "phone2display": "string"
        },
        "prizorKioskUnlockByTouch": "string",
        "prizorKioskUnlockByQRCode": "string",
        "personAuthenticationType": [
            "string"
        ]
    }
}
Modificado em 2025-03-28 17:39:52
Página anterior
Listagem de Campanhas
Próxima página
Gerar URL
Built with