Update a program's organizational access

post

/rest/api/v1.3/attributes/programs/{programName}

Update the organizations that can access a program.

Request

Supported Media Types
Path Parameters
Body ()
Request Body
Root Schema : Edit Access Attributes Request
Type: object
Title: Edit Access Attributes Request
Show Source
Nested Schema : attributes
Type: object
Show Source
Nested Schema : organizations
Type: object
Show Source
Nested Schema : attributeValues
Type: array
List of Attributes to be assigned
Show Source
Nested Schema : items
Type: object
Attribute name
Show Source
Back to Top

Response

Supported Media Types

Default Response

Body ()
Root Schema : Get Assigned Organizations
Type: object
Title: Get Assigned Organizations
Show Source
Nested Schema : attributes
Type: object
Show Source
Nested Schema : organizations
Type: object
Show Source
Nested Schema : attributeValues
Type: array
Value of the Assigned Attributes
Show Source
Nested Schema : assigned attribute
Type: object
Title: assigned attribute
Show Source
Back to Top

Examples

Use this interface to update the organizations that can access a program. 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 program. Invalid attribute value: usa",
  "errorDetails": []
}
	
Back to Top