Listagem

Listagem das campanhas de uma determinada conta.

GET: https://DOMINIO/api/v1/accounts/ID_CONTA/campaigns

Retorno de status HTTP: 200

Retorno:

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
{
  "page" : {
    "current" : 1,
    "total" : 1
  },
  "items" : [
    {
      "id" : "4f56a5e44cfc37be83000002",
      "name" : "Campanha 1"
    },
    {
      "id" : "4f4d36fe4cfc379014000001",
      "name" : "Campanha 2"
    }
  ]
}

Detalhes

Detalhes de uma determinada campanha.

GET: https://DOMINIO/api/v1/accounts/ID_CONTA/campaigns/ID_CAMPANHA

Retorno de status HTTP: 200

Retorno:

1
2
3
4
5
6
{
  "id" : "4f56a5e44cfc37be83000002",
  "created_at" : "12-01-01 00:00:00",
  "updated_at" : "12-01-01 00:00:00",
  "name" : "Campanha 1"
}

Criação

Criação de campanhas

POST: https://DOMINIO/api/v1/accounts/ID_CONTA/campaigns

Parametros:

1
2
3
4
5
6
{
  "campaign" : {
    "name" : "Campanha 1",
    "description" : "Descricao campanha 1"
  }
}

Retorno de status HTTP: 200

Retorno:

1
2
3
{
  "id" : "4fe3684e2c1e5806df000001"
}

Edição

Atualizar determinada campanha.

PUT: https://DOMINIO/api/v1/accounts/ID_CONTA/campaigns/ID_CAMPANHA

Parametros:

1
2
3
4
5
6
{
  "campaign" : {
    "name" : "Campanha 1 Alterada",
    "description" : "Descricao campanha 1 Alterada"
  }
}

Retorno de status HTTP: 204

Retorno: “”

Remoção

Remover determinada campanha.

DELETE: https://DOMINIO/api/v1/accounts/ID_CONTA/campaigns/ID_CAMPANHA

Retorno de status HTTP: 204

Retorno: “”