< Back to zoomrank.com

Batch Create Keywords

URL

http://vendor.zoomrank.com/accounts/:account_id/keywords/batch.json

Supported formats

JSON

Supported request methods

POST

Example

Create a new keyword for account ID 1

http://vendor.zoomrank.com/accounts/1/keywords/batch.json

Request Body

A JSON array of keyword objects (50 record limit).

Keyword Object

Field Description Format
external_id Your unique identifier char(125)
engine_id Search engine ID 1 = Google
2 = Yahoo
3 = Bing
term Search term
mobile mobile or SERP true = mobile keyword
false = SERP keyword
country Country See Supported Countries
language Language (Google Only) See Supported Languages
location Search Location (Google Only) City,ST
dow Weekly ranking day-of-week 0 - 6 (0 = Sunday)
last_processed_date Date of which record was last processed YYYY-MM-DD

Response Codes

201 - Success
400 - Bad request. See error response.
500 - Unexpected error. Try again.

Example Request (Google - Default Country/Language/Location)

[
	{
		"external_id": "kw1_google",
		"engine_id": 1,
		"term": "term 1",
		"mobile": false
	},
	{
		"external_id": "kw1_bing",
		"engine_id": 3,
		"term": "term 1",
		"mobile": true
	},
	{
		"external_id": "kw2_google",
		"engine_id": 1,
		"term": "term 2",
		"mobile": false
	},
	{
		"external_id": "kw3_google",
		"engine_id": 1,
		"term": "term 3",
		"mobile": false
	}
]

Example Response (success)

[
	{
		"id": 1,
		"account_id": 1,
		"external_id": "kw1_google",
		"engine_id": 1,
		"term": "term 1",
		"mobile": false,
		"country": "US",
		"language": "EN",
		"location": "Dallas,TX",
		"dow": 6
	},
	{
		"id": 2,
		"account_id": 1,
		"external_id": "kw1_bing",
		"engine_id": 3,
		"term": "term 1",
		"mobile": false,
		"country": "US",
		"dow": 5
	},
	...
]

Example Response (error) - Record validation errors

[
	{
		"account_id": 1,
		"external_id": "kw1_google",
		"term": "term 1",
		"mobile": false,
		"engine_id": 1,
		"country": "US",
		"language": "EN",
		"location": "Dallas,TX",
		"errors": [
			"Keyword already exists (56)"
		]
	},
	...
]

Example Response (error) - Record limit exceeded

{ "error": "Batch exceeds 50 keyword limit." }