Campaigns

Listar campanhas

get

Retorna campanhas conforme filtros enviados.

Autorizações

JwtAuth

AuthorizationstringObrigatório

Token JWT no header Authorization.

Respostas

200

Sucesso.

application/json

Other propertiesanyOpcional

get

/v4/campaigns

HTTPcURLJavaScriptPython

GET /api/v4/campaigns HTTP/1.1
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*

200

Sucesso.

{
  "status": true,
  "message": "Sucesso"
}

Criar campanha

post

Cria campanha com os dados enviados.

Autorizações

JwtAuth

AuthorizationstringObrigatório

Token JWT no header Authorization.

Corpo

application/json

Other propertiesanyOpcional

Respostas

200

Sucesso.

application/json

Other propertiesanyOpcional

post

/v4/campaigns

HTTPcURLJavaScriptPython

POST /api/v4/campaigns HTTP/1.1
Authorization: Bearer YOUR_SECRET_TOKEN
Content-Type: application/json
Accept: */*
Content-Length: 21

{
  "name": "Campanha 1"
}

200

Sucesso.

{
  "status": true,
  "message": "Sucesso"
}

Detalhar campanha

get

Recupera os dados de campanha identificado no caminho.

Autorizações

JwtAuth

AuthorizationstringObrigatório

Token JWT no header Authorization.

Parâmetros de rota

idstringObrigatórioExample: camp_123

Respostas

200

Sucesso.

application/json

Other propertiesanyOpcional

get

/v4/campaigns/{id}

HTTPcURLJavaScriptPython

GET /api/v4/campaigns/{id} HTTP/1.1
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*

200

Sucesso.

{
  "status": true,
  "message": "Sucesso"
}

Atualizar campanha

put

Atualiza campanha conforme os dados enviados.

Autorizações

JwtAuth

AuthorizationstringObrigatório

Token JWT no header Authorization.

Parâmetros de rota

idstringObrigatório

Corpo

application/json

Other propertiesanyOpcional

Respostas

200

Sucesso.

application/json

Other propertiesanyOpcional

put

/v4/campaigns/{id}

HTTPcURLJavaScriptPython

PUT /api/v4/campaigns/{id} HTTP/1.1
Authorization: Bearer YOUR_SECRET_TOKEN
Content-Type: application/json
Accept: */*
Content-Length: 30

{
  "name": "Campanha Atualizada"
}

200

Sucesso.

{
  "status": true,
  "message": "Sucesso"
}

Remover campanha

delete

Remove campanha identificado no caminho.

Autorizações

JwtAuth

AuthorizationstringObrigatório

Token JWT no header Authorization.

Parâmetros de rota

idstringObrigatório

Respostas

200

Sucesso.

application/json

Other propertiesanyOpcional

delete

/v4/campaigns/{id}

HTTPcURLJavaScriptPython

DELETE /api/v4/campaigns/{id} HTTP/1.1
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*

200

Sucesso.

{
  "status": true,
  "message": "Sucesso"
}

Filtrar campanhas por IDs

post

Processa a solicitação de filtrar campanhas por IDs e retorna o resultado.

Autorizações

JwtAuth

AuthorizationstringObrigatório

Token JWT no header Authorization.

Corpo

application/json

campaingsstring[]Obrigatório

paginatebooleanOpcional

limitinteger · mín: 1Opcional

pageinteger · mín: 1Opcional

Respostas

200

Sucesso.

application/json

Other propertiesanyOpcional

post

/v4/campaigns/filterByIds

HTTPcURLJavaScriptPython

POST /api/v4/campaigns/filterByIds HTTP/1.1
Authorization: Bearer YOUR_SECRET_TOKEN
Content-Type: application/json
Accept: */*
Content-Length: 69

{
  "campaings": [
    "camp_1",
    "camp_2"
  ],
  "paginate": true,
  "limit": 10,
  "page": 1
}

200

Sucesso.

{
  "status": true,
  "message": "Sucesso"
}

Resumo de campanhas

get

Processa a solicitação de resumo de campanhas e retorna o resultado.

Autorizações

JwtAuth

AuthorizationstringObrigatório

Token JWT no header Authorization.

Parâmetros de rota

paginatestringObrigatórioExample: true

Respostas

200

Sucesso.

application/json

Other propertiesanyOpcional

get

/v4/campaigns/resume/{paginate}

HTTPcURLJavaScriptPython

GET /api/v4/campaigns/resume/{paginate} HTTP/1.1
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*

200

Sucesso.

{
  "status": true,
  "message": "Sucesso"
}