v1

latestSwagger 2.0Apache 2.02026-07-13123128517.6 KB

keywords

Find a specific lease

Searches for all keywords owned by user

get/keywords/leases/{keyword}

keywordstring required

Keyword text that a lease is desired for

fieldsstring

Limit fields received in response. E.g. fields: id, name or fields items (id, name), see more at partial response page.

successful operation

shortCodestring

A short code assigned to keyword. Example: 67076 (Deprecated - please use number instead)

numberstring

A number assigned to keyword. Example: 12132212344

keywordstring

A text used as a keyword

leaseBegininteger

A time of a lease timestamp, formatted in unix time milliseconds (read only). Example: 1473781817000 for Sat, 05 Jan 1985 14:03:37 GMT

leaseEndinteger

A date and time when the keyword lease is finishes. Timestamp, formatted in unix time milliseconds (read only). Example: 1473781817000

autoRenewboolean

Enables the auto renewal of a keyword lease at the end of each billing cycle

doubleOptInEnabledboolean

Enable/disable double opt in feature

optInConfirmationMessagestring

Opt in confirmation message

contactListIdinteger

Existing contact list ID

status'PENDING' | 'ACTIVE' | 'RELEASED' | 'UNAVAILABLE'

A lease status. Available values: PENDING, ACTIVE, RELEASED, UNAVAILABLE

labelsstring[]

type'PLAN' | 'EXTRA'