Jump to

• Request
• Response
• Examples

Update a Campaign's Proof List

put

/rest/api/v1.3/campaigns/{campaignName}/attributes/proofList

Updates the Proof List associated with a Campaign

Request

Supported Media Types

• application/json

Path Parameters

• campaignName: string
  Name of the Campaign

Body ()

Root Schema : Campaign Proof List Request

Type: object

Title: Campaign Proof List Request

Show Source

• attributeData: object attributeData
  Describes the attribute of the campaign to be updated
• attributeName: string
  Allowed Values: [ "proofList" ]

  The attribute of the campaign. Should be "proofList"

{
    "title":"Campaign Proof List Request",
    "type":"object",
    "properties":{
        "attributeName":{
            "description":"The attribute of the campaign. Should be \"proofList\" ",
            "type":"string",
            "enum":[
                "proofList"
            ]
        },
        "attributeData":{
            "description":"Describes the attribute of the campaign to be updated",
            "type":"object",
            "properties":{
                "name":{
                    "description":"The name of the Proof List to update",
                    "type":"string"
                }
            }
        }
    },
    "required":[
        "attributeName",
        "attributeData"
    ]
}

Nested Schema : attributeData

Type: object

Describes the attribute of the campaign to be updated

Show Source

• name(optional): string
  The name of the Proof List to update

{
    "description":"Describes the attribute of the campaign to be updated",
    "type":"object",
    "properties":{
        "name":{
            "description":"The name of the Proof List to update",
            "type":"string"
        }
    }
}

Back to Top

Response

Supported Media Types

• application/json

Default Response

Body ()

Root Schema : Campaign Proof List Response

Type: object

Title: Campaign Proof List Response

Show Source

• attributeData: object Proof List
  Title: Proof List
• attributeName: string
  Allowed Values: [ "proofList" ]

  The attribute of the campaign. "ProofList" in this scenario

{
    "title":"Campaign Proof List Response",
    "type":"object",
    "properties":{
        "attributeName":{
            "description":"The attribute of the campaign. \"ProofList\" in this scenario",
            "type":"string",
            "enum":[
                "proofList"
            ]
        },
        "attributeData":{
            "$ref":"#/definitions/proofList"
        }
    },
    "required":[
        "attributeName",
        "attributeData"
    ]
}

Nested Schema : Proof List

Type: object

Title: Proof List

Show Source

• createdBy: string
  User who created the Proof List
• createdDate: string(date)
  Proof List creation date
• description: string
  Proof List description
• folderName: string
  Folder containing the Proof List
• listName: string
  Profile list name for which the Proof List is associated
• modifiedBy: string
  User who modified the Proof List
• modifiedDate: string(date)
  Proof List modification date
• name: string
  Proof List Name

{
    "title":"Proof List",
    "type":"object",
    "properties":{
        "name":{
            "description":"Proof List Name",
            "type":"string"
        },
        "description":{
            "description":"Proof List description",
            "type":"string"
        },
        "listName":{
            "description":"Profile list name for which the Proof List is associated",
            "type":"string"
        },
        "folderName":{
            "description":"Folder containing the Proof List",
            "type":"string"
        },
        "createdBy":{
            "description":"User who created the Proof List",
            "type":"string"
        },
        "createdDate":{
            "description":"Proof List creation date",
            "type":"string",
            "format":"date"
        },
        "modifiedBy":{
            "description":"User who modified the Proof List",
            "type":"string"
        },
        "modifiedDate":{
            "description":"Proof List modification date",
            "type":"string",
            "format":"date"
        }
    },
    "required":[
        "name",
        "description",
        "listName",
        "folderName",
        "createdBy",
        "createdDate",
        "modifiedBy",
        "modifiedDate"
    ]
}

Back to Top

Examples

Use this interface to update the proof list associated with the specified campaign. The response returns the proof list object, which includes the proof list name and the list's other properties. The links array contains the proof list's object's related API operations, specific to the campaign name.

Required request headers:

FIELDS	DESCRIPTION
Authorization	<AUTH_TOKEN>
Content-Type	application/json

Sample Request URL

/rest/api/v1.3/campaigns/example_campaign/attributes/proofList

Sample Request Body

{
  "attributeName": "proofList",
  "attributeData": {
    "name": "myprooflist"
  }
}

Response Notes:

Sample Response Body

{
  "attributeName": "proofList",
  "attributeData": {
    "name": "testproofList",
    "description": "Proof List Description",
    "listName": "testlist",
    "folderName": "~System",
    "createdBy": "api.user",
    "createdDate": "2020-07-28",
    "modifiedBy": "api.user",
    "modifiedDate": "2020-07-28"
  },
  "links": [
    {
      "rel": "self",
      "href": "/rest/api/v1.3/campaigns/mycampaign/attributes/proofList",
      "method": "PUT"
    },
    {
      "rel": "getCampaignAttribute",
      "href": "/rest/api/v1.3/campaigns/mycampaign/attributes/proofList",
      "method": "GET"
    }
  ]
}
	

Troubleshooting Failures

The system returns error responses in the following situations.

Invalid character specified for campaign name: A 400 bad request error is returned with the following error response body (where the table name sent is returned in the square brackets):

{
  "type": "",
  "title": "Invalid request parameters",
  "errorCode": "INVALID_PARAMETER",
  "detail": "Invalid characters in the Campaign name: Example.Campaign",
  "errorDetails": []
}
	

Campaign does not exist: A 404 not found error is returned with the following error response body (where the campaign name sent is returned in the square brackets):

{
  "type": "",
  "title": "Campaign not found",
  "errorCode": "CAMPAIGN_NOT_FOUND",
  "detail": "[ Example.Campaign ] Campaign Not Found",
  "errorDetails": []
}
	

Invalid attribute name: A 400 bad request error is returned with the following error response body:

{
  "type": "",
  "title": "Invalid request parameters",
  "errorCode": "INVALID_PARAMETER",
  "detail": "Invalid attribute name :filter",
  "errorDetails": []
}
	

Campaign name exceeds character limit: A 400 bad request error is returned with the following error response body:

{
  "type": "",
  "title": "Invalid request parameters",
  "errorCode": "INVALID_PARAMETER",
  "detail": "Maximum characters allowed for Campaign name: SourceCampaignSourceCampaignSourceCampaignSourceCampaignSourceCampaignSourceCampaignSourceCampaignSourceCampaignSourceCampaignSourceCampaignSourceCamp2 is 150",
  "errorDetails": []
}

	

User does not have permissions to access the campaign: A 401 unauthorized error is returned with the following error response body:

{
  "type": "",
  "title": "Insufficient access",
  "errorCode": "INSUFFICIENT_ACCESS",
  "detail": "User api.user does not have access to campaign [Example_Campaign]",
  "errorDetails": []
}
	

User does not have the campaign web services manager role: A 401 unauthorized error is returned with the following error response body:

{
  "type": "",
  "title": "Insufficient access",
  "errorCode": "INSUFFICIENT_ACCESS",
  "detail": "Insufficient privileges to invoke this API",
  "errorDetails": []
}
	

Proof list name contains invalid character: A 400 bad request error is returned with the following error response body:

{
  "type": "",
  "title": "Invalid request parameters",
  "errorCode": "INVALID_PARAMETER",
  "detail": "Invalid characters in the ProofList Name",
  "errorDetails": []
}
	

Proof list name exceeds 100 characters: A 400 bad request error is returned with the following error response body:

{
  "type": "",
  "title": "Invalid request parameters",
  "errorCode": "INVALID_PARAMETER",
  "detail": "Max Length of proofListName allowed: 100",
  "errorDetails": []
}
	

Attribute name specified in the request URL is not proofList: A 400 bad request error is returned with the following error response body:

{
  "type": "",
  "title": "Invalid request parameters",
  "errorCode": "INVALID_PARAMETER",
  "detail": "Invalid attribute name :test",
  "errorDetails": []
}
	

The proof list specified either does not exist, or the list is not set to the campaign: A 400 bad request error is returned with the following error response body:

{
  "type": "",
  "title": "Proof list not found",
  "errorCode": "PROOF_LIST_NOT_FOUND",
  "detail": "ProofList [ proof_list1 ] not found for Profile list set for Campaign: [ Example_Campaign]",
  "errorDetails": []
}
	

The profile list not set to the campaign: A 400 bad request error is returned with the following error response body:

{
  "type": "",
  "title": "Proof list not found",
  "errorCode": "PROOF_LIST_NOT_FOUND",
  "detail": "ProofList [ proof_list1 ] not found for Profile list set for Campaign: [ Example_Campaign]",
  "errorDetails": []
}
	

Back to Top