Campanhas

Recuperar todos

GET https://provasocialplus.com.br/api/campaigns/
curl --request GET \
--url 'https://provasocialplus.com.br/api/campaigns/' \
--header 'Authorization: Bearer {api_key}' \
Parâmetros Detalhes Descrição
page Opcional Inteiro O número da página de onde você deseja obter os resultados. O valor padrão é 1.
results_per_page Opcional Inteiro Quantos resultados você deseja por página. Os valores permitidos são: 10 , 25 , 50 , 100 , 250 , 500 , 1000. O padrão é 25.
{ "data": [ { "id": 1, "pixel_key": "1234567890abcdef", "name": "Example", "domain": "example.com", "branding": { "name": "", "url": "" }, "email_reports_is_enabled": true, "email_reports_last_datetime": "2019-05-22 23:40:17", "is_enabled": true, "last_datetime": null, "datetime": "2019-05-22 23:40:17" } ], "meta": { "page": 1, "results_per_page": 25, "total": 1, "total_pages": 1 }, "links": { "first": "https://provasocialplus.com.br/api/campaigns?&page=1", "last": "https://provasocialplus.com.br/api/campaigns?&page=1", "next": null, "prev": null, "self": "https://provasocialplus.com.br/api/campaigns?&page=1" } }

Recuperar um

GET https://provasocialplus.com.br/api/campaigns/{campaign_id}
curl --request GET \
--url 'https://provasocialplus.com.br/api/campaigns/{campaign_id}' \
--header 'Authorization: Bearer {api_key}' \
{ "data": { "id": 1, "pixel_key": "1234567890abcdef", "name": "Example", "domain": "example.com", "branding": { "name": "", "url": "" }, "email_reports_is_enabled": true, "email_reports_last_datetime": "2019-05-22 23:40:17", "is_enabled": true, "last_datetime": null, "datetime": "2019-05-22 23:40:17" } }

Criar

POST https://provasocialplus.com.br/api/campaigns
Parâmetros Detalhes Descrição
domain_id Opcional Inteiro -
name Obrigatório String -
domain Obrigatório String -
branding_name Opcional String -
branding_url Opcional String -
email_reports Opcional Matriz Identificadores de manipulador de notificações
is_enabled Opcional Boolean -
curl --request POST \
--url 'https://provasocialplus.com.br/api/campaigns' \
--header 'Authorization: Bearer {api_key}' \
--header 'Content-Type: multipart/form-data' \
--form 'name=Example' \
--form 'domain=example.com' \
{ "data": { "id": 1 } }

Atualizar

POST https://provasocialplus.com.br/api/campaigns/{campaign_id}
Parâmetros Detalhes Descrição
domain_id Opcional Inteiro -
name Opcional String -
domain Opcional String -
branding_name Opcional String -
branding_url Opcional String -
email_reports Opcional Matriz Identificadores de manipulador de notificações
is_enabled Opcional Boolean -
curl --request POST \
--url 'https://provasocialplus.com.br/api/campaigns/{campaign_id}' \
--header 'Authorization: Bearer {api_key}' \
--header 'Content-Type: multipart/form-data' \
--form 'is_enabled=0' \
{ "data": { "id": 1 } }

Excluir

DELETE https://provasocialplus.com.br/api/campaigns/{campaign_id}
curl --request DELETE \
--url 'https://provasocialplus.com.br/api/campaigns/{campaign_id}' \
--header 'Authorization: Bearer {api_key}' \