Campaigns
Create a Campaign
Creates a new campaign
Arguments
| url required string | Website address |
| company required string | A company name, usually the company for which the campaign is made |
| scope string | Scope of |
| group_title string | The group to assign this campaign to |
Endpoint
POST /v3/campaigns
Response
{
"metadata": {
"total_pages": 1,
"total_records": 1
},
"data": {
"id": 123,
"date_created": "2015-03-30 10:06:24",
"date_modified": null,
"url": "http://www.test.com",
"company": "Acme Inc.",
"scope": "domain",
"account_id": 567
}
}
Retrieve a Campaign
Retrieves an existing campaign object
Arguments
| id required integer (32) | The ID of the campaign to retrieve |
Endpoint
GET /v3/campaigns/:id
Response
{
"metadata": {
"total_pages": 1,
"total_records": 1
},
"data": {
"id": 123,
"date_created": "2015-03-30 10:06:24",
"date_modified": null,
"url": "http://www.test.com",
"company": "Acme Inc.",
"scope": "domain",
"group_title": null,
"account_id": 567
}
}
Update a Campaign
Update an existing campaign. This endpoint returns the modified campaign object as a response.
Arguments
| id required inteer (32) | The ID of the campaign to update |
| url string | website address |
| company string | company name |
| scope string | group name |
Endpoint
PUT /v3/campaigns/:id
Response
{
"metadata": {
"total_pages": 1,
"total_records": 1
},
"data": {
"id": 123,
"date_created": "2015-03-30 10:06:24",
"date_modified": null,
"url": "http://www.test.com",
"company": "Acme Inc.",
"scope": "domain",
"group_title": null,
"account_id": 567
}
}
List all Campaigns
Retrieves a list of all campaigns associatied with the current account. By default, campaigns are returned from oldest to newest.
Arguments
| filter string | Name of a campaign to search for |
| page integer (32) | Page to return |
| limit integer (32) | Maximum number of results to return |
| order_by string | A field to order the results by |
| order_direction string | The direction of the sort specified by |
Endpoint
GET /v3/campaigns
Response
{
"metadata": {
"total_pages": 1,
"total_records": 1
},
"data": [
{
"id": 42,
"date_created": "2018-08-01 00:00:00",
"date_modified": "2018-11-01 22:25:37",
"date_deleted": null,
"url": "http://test.com",
"company": "test",
"status": "active",
"scope": "domain",
"google_ignore_places": "false",
"google_places_id": null,
"google_cid": null,
"google_mybusiness_id": null,
"google_mybusiness_name": null,
"group_title": null,
"timezone": null,
"account_id": 1
}
]
}
Delete a Campaign
Deletes the given campaign. Returns 204 No Content when successful.
Arguments
| id required integer | The ID of the campaign to delete. |
Endpoint
DELETE /v3/campaigns/:id