Jump to

• Request
• Response
• Examples

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

Body ()

Request Body

Root Schema : Edit Access Attributes Request

Type: object

Title: Edit Access Attributes Request

Show Source

• attributes(optional): object attributes

{
    "title":"Edit Access Attributes Request",
    "type":"object",
    "properties":{
        "attributes":{
            "type":"object",
            "properties":{
                "organizations":{
                    "type":"object",
                    "properties":{
                        "attributeValues":{
                            "description":"List of Attributes to be assigned",
                            "type":"array",
                            "items":{
                                "type":"object",
                                "description":"Attribute name",
                                "properties":{
                                    "name":{
                                        "type":"string",
                                        "description":"Name of the Attribute to be assigned"
                                    }
                                }
                            }
                        }
                    }
                }
            }
        }
    }
}

Nested Schema : attributes

Type: object

Show Source

• organizations(optional): object organizations

{
    "type":"object",
    "properties":{
        "organizations":{
            "type":"object",
            "properties":{
                "attributeValues":{
                    "description":"List of Attributes to be assigned",
                    "type":"array",
                    "items":{
                        "type":"object",
                        "description":"Attribute name",
                        "properties":{
                            "name":{
                                "type":"string",
                                "description":"Name of the Attribute to be assigned"
                            }
                        }
                    }
                }
            }
        }
    }
}

Nested Schema : organizations

Type: object

Show Source

• attributeValues(optional): array attributeValues
  List of Attributes to be assigned

{
    "type":"object",
    "properties":{
        "attributeValues":{
            "description":"List of Attributes to be assigned",
            "type":"array",
            "items":{
                "type":"object",
                "description":"Attribute name",
                "properties":{
                    "name":{
                        "type":"string",
                        "description":"Name of the Attribute to be assigned"
                    }
                }
            }
        }
    }
}

Nested Schema : attributeValues

Type: array

List of Attributes to be assigned

Show Source

• Array of: object items
  Attribute name

{
    "description":"List of Attributes to be assigned",
    "type":"array",
    "items":{
        "type":"object",
        "description":"Attribute name",
        "properties":{
            "name":{
                "type":"string",
                "description":"Name of the Attribute to be assigned"
            }
        }
    }
}

Nested Schema : items

Type: object

Attribute name

Show Source

• name(optional): string
  Name of the Attribute to be assigned

{
    "type":"object",
    "description":"Attribute name",
    "properties":{
        "name":{
            "type":"string",
            "description":"Name of the Attribute to be assigned"
        }
    }
}

Back to Top

Response

Supported Media Types

• application/json

Default Response

Body ()

Root Schema : Get Assigned Organizations

Type: object

Title: Get Assigned Organizations

Show Source

• attributes(optional): object attributes

{
    "title":"Get Assigned Organizations",
    "type":"object",
    "properties":{
        "attributes":{
            "type":"object",
            "properties":{
                "organizations":{
                    "type":"object",
                    "properties":{
                        "attributeValues":{
                            "description":"Value of the Assigned Attributes",
                            "type":"array",
                            "items":{
                                "$ref":"#/definitions/assigned-attribute"
                            }
                        }
                    }
                }
            }
        }
    }
}

Nested Schema : attributes

Type: object

Show Source

• organizations(optional): object organizations

{
    "type":"object",
    "properties":{
        "organizations":{
            "type":"object",
            "properties":{
                "attributeValues":{
                    "description":"Value of the Assigned Attributes",
                    "type":"array",
                    "items":{
                        "$ref":"#/definitions/assigned-attribute"
                    }
                }
            }
        }
    }
}

Nested Schema : organizations

Type: object

Show Source

• attributeValues(optional): array attributeValues
  Value of the Assigned Attributes

{
    "type":"object",
    "properties":{
        "attributeValues":{
            "description":"Value of the Assigned Attributes",
            "type":"array",
            "items":{
                "$ref":"#/definitions/assigned-attribute"
            }
        }
    }
}

Nested Schema : attributeValues

Type: array

Value of the Assigned Attributes

Show Source

• Array of: object assigned attribute
  Title: assigned attribute

{
    "description":"Value of the Assigned Attributes",
    "type":"array",
    "items":{
        "$ref":"#/definitions/assigned-attribute"
    }
}

Nested Schema : assigned attribute

Type: object

Title: assigned attribute

Show Source

• id(optional): string
  ID of the attribute
• lineage(optional): string
  Description of the attribute's heirarchy
• name(optional): string
  Name of the attribute

{
    "type":"object",
    "title":"assigned attribute",
    "properties":{
        "id":{
            "description":"ID of the attribute",
            "type":"string"
        },
        "name":{
            "description":"Name of the attribute",
            "type":"string"
        },
        "lineage":{
            "description":"Description of the attribute's heirarchy",
            "type":"string"
        }
    }
}

Back to Top

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": [
    
  ]
}
	

Back to Top