Update a campaign's organizational access
post
/rest/api/v1.3/attributes/campaigns/{campaignName}
Update the organizations that can access a campaign.
Request
Supported Media Types
- application/json
Path Parameters
-
campaignName: string
The Campaign name
Request Body
Root Schema : Edit Access Attributes Request
Type:
object
Title:
Show Source
Edit Access Attributes Request
Nested Schema : organizations
Type:
Show Source
object
-
attributeValues(optional):
array attributeValues
List of Attributes to be assigned
Nested Schema : attributeValues
Type:
array
List of Attributes to be assigned
Show Source
-
Array of:
object items
Attribute name
Nested Schema : items
Type:
object
Attribute name
Show Source
-
name(optional):
string
Name of the Attribute to be assigned
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
Use this interface to update the organizations that can access a campaign. To learn more about Organizations in Responsys, see the Responsys Help Center.
FIELDS | DESCRIPTION |
---|---|
Authorization | <AUTH_TOKEN> |
Content-Type | application/json |
Sample Request Body:
{ "attributes": { "organizations": { "attributeValues": [ { "name": "USA" }, { "name": "APAC" }, { "name": "Global" } ] } } }
Sample Response
{ "attributes": { "organizations": { "attributeValues": [ { "id": 7, "name": "USA", "lineage": "7:" }, { "id": 4000007, "name": "APAC", "lineage": "7:4000007:" }, { "id": 12000007, "name": "Global", "lineage": "7:12000007:" } ] } } }
Sample Error
If the attribute does not match an existing organization, the following error will be returned.
{ "type": "", "title": "Set Object Attribute Exception", "errorCode": "SET_OBJECT_ATTRIBUTE_EXCEPTION", "detail": "Unable to set Access Attributes for the campaign. Invalid attribute value: Usa", "errorDetails": [ ] }