Fetch a campaign's organization hierarchy
get
/rest/api/v1.3/attributes/campaigns/{campaignName}
Fetch a list of organizations that can access a campaign.
Request
Supported Media Types
- application/json
Path Parameters
-
campaignName: string
The Campaign name
Response
Supported Media Types
- application/json
Default Response
Nested Schema : organizations
Type:
Show Source
object
-
attributeValues(optional):
array attributeValues
Value of the Assigned Attributes
Nested Schema : attributeValues
Type:
array
Value of the Assigned Attributes
Show Source
-
Array of:
object assigned attribute
Title:
assigned attribute
Nested Schema : assigned attribute
Type:
object
Title:
Show Source
assigned attribute
-
id(optional):
string
ID of the attribute
-
lineage(optional):
string
Description of the attribute's heirarchy
-
name(optional):
string
Name of the attribute
Examples
This interface is used to retrieve the organizations which have access to a campaign. To learn more about Organizations in Responsys, see the Responsys Help Center.
A successful request requires the following headers:
FIELDS | DESCRIPTION |
---|---|
Authorization | <AUTH_TOKEN> |
Sample Request URL:
/rest/api/v1.3/attributes/campaigns/example_campaign
Sample response : Success
{ "attributes": { "organizations": { "attributeValues": [ { "id": 7, "name": "USA", "lineage": "7:" }{ "id": 8, "name": "Asia", "lineage": "7:10005" } ] } } }
Sample Response: Failure
If the campaign does not exist, the error will resemble the following:
{ "type": "", "title": "Campaign not found", "errorCode": "CAMPAIGN_NOT_FOUND", "detail": "Campaign with the name example_campaig not found", "errorDetails": [] }