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
  • Esquemas
    • Transbordo
      • transbordo - completo com itens
    • Campanhas
      • Listagem de Campanhas
      • campaignStatus
  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 de Caminho

Códigos de solicitaçã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' \
--header 'Authorization: Bearer <token>'

Respostas

🟢200Success
application/json
Body

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,
        "hasStoreRating": true,
        "hasNps": true,
        "ignoreCampaignPeriodRestriction": 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"
        },
        "partnerCreditCard": {
            "enabled": true,
            "icon": "{host}/files/credit-card/2344/4e10272a-1834-1234-bb19-00d505297137.png",
            "initialScreen": {
                "title": "Desbloqueie benefícios com seu cartão de crédito."
            },
            "popUp": {
                "title": "Aumente suas chances de ganhar benefícios com um cartão parceiro.",
                "body": "Se você tem um dos cartões de crédito listados abaixo, cadastre e amplie suas chances.",
                "cancelButton": "NÃO, OBRIGADO",
                "confirmButton": "VERIFICAR CARTÃO",
                "listCards": true
            },
            "cardManagement": {
                "title": "Desbloqueie benefícios com seu cartão de crédito.",
                "body": "Se você tem um dos cartões de crédito listados abaixo, insira os primeiros 6 dígitos e <b>amplie suas chances de receber benefícios exclusivos</b>.",
                "listCards": true
            }
        },
        "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