Campaign

List campaigns

get

https://preprodapim.hos.accessacloud.com/rd-consumer-apihttps://apim.hos.accessacloud.com/rd-consumer-api

/api/ConsumerApi/v1/Campaigns

Gets a list of campaigns

Authorizations

bearerAuth

HTTPRequired

Bearer token using a JWT

Query parameters

api-versionstringOptional

Responses

200

OK

application/jsontext/jsonapplication/problem+jsonapplication/xmltext/xml

string[]Optional

get

/api/ConsumerApi/v1/Campaigns

HTTPcURLJavaScriptPython

GET /rd-consumer-api/api/ConsumerApi/v1/Campaigns HTTP/1.1
Host: preprodapim.hos.accessacloud.com
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*

200

OK

[
  "text"
]

Get a campaign

get

https://preprodapim.hos.accessacloud.com/rd-consumer-apihttps://apim.hos.accessacloud.com/rd-consumer-api

/api/ConsumerApi/v1/Campaign/{campaignName}

Gets the campaign with the specified name.

Authorizations

bearerAuth

HTTPRequired

Bearer token using a JWT

Path parameters

campaignNamestringRequired

The name of the campaign.

Query parameters

api-versionstringOptional

Responses

200

OK

application/jsontext/jsonapplication/problem+jsonapplication/xmltext/xml

Contains the details of a marketing campaign.

Idinteger · int32Optional

The campaign's Id.

NamestringOptional

The name of the campaign.

Latitudenumber · doubleOptional

The latitude to search for.

Longitudenumber · doubleOptional

The longitude to search for.

Radiusinteger · int32Optional

The search radius.

DescriptionstringOptional

The description of the campaign.

CopystringOptional

The marketing copy to be displayed.

PageTitlestringOptional

The page title.

MetaDescriptionstringOptional

The description meta tag contents.

MetaKeywordsstringOptional

The keywords meta tag contents.

HeaderImageUrlstringOptional

The URL to the header image.

CreateDatestringOptional

When the campaign was created.

UpdateDatestringOptional

When the campaign was last updated.

get

/api/ConsumerApi/v1/Campaign/{campaignName}

HTTPcURLJavaScriptPython

GET /rd-consumer-api/api/ConsumerApi/v1/Campaign/{campaignName} HTTP/1.1
Host: preprodapim.hos.accessacloud.com
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*

200

OK

{
  "Id": 1,
  "Name": "sample string 2",
  "Latitude": 3.1,
  "Longitude": 4.1,
  "Radius": 5,
  "Description": "sample string 6",
  "Copy": "sample string 7",
  "PageTitle": "sample string 8",
  "MetaDescription": "sample string 9",
  "MetaKeywords": "sample string 10",
  "HeaderImageUrl": "sample string 11",
  "CreateDate": "sample string 12",
  "UpdateDate": "sample string 13"
}