Jump to

• Request
• Response
• Examples

Update an email folder

put

/api/REST/1.0/assets/email/folder/{id}

Updates the email folder specified by the id parameter. All properties should be included in PUT requests, as some properties will be considered blank if not included.

Request

Supported Media Types

• application/json

Path Parameters

• id(required): integer
  Id of the email folder to update.

Body ()

The request body defines the details of the email folder to be updated.

Root Schema : Folder

Type: object

Title: Folder

Show Source

• createdAt: string
  Read Only: true

  The date and time the email folder was created, expressed in Unix time.
• createdBy: string
  Read Only: true

  The login id of the user who created the email folder.
• currentStatus: string
  The email folder's current status.
• depth: string
  Read Only: true

  Level of detail returned by the request. Eloqua APIs can retrieve entities at three different levels of depth: minimal, partial, and complete. Any other values passed are reset to complete by default. For more information, see Request depth.
• description: string
  The description of the email folder.
• id: string
  Read Only: true

  Id of the email folder. This is a read-only property.
• isSystem: string
  Read Only: true

  Whether or not the email folder is a system folder.
• name: string
  The name of the email folder.
• permissions: string
  The permissions for the email folder granted to your current instance. This is a read-only property.
• type: string
  The asset's type in Eloqua. This is a read-only property.
• updatedAt: string
  Read Only: true

  Unix timestamp for the date and time the email folder was last updated.
• updatedBy: string
  Read Only: true

  The login id of the user that last updated the email folder.

{
    "title":"Folder",
    "properties":{
        "type":{
            "type":"string",
            "description":"The asset's type in Eloqua. This is a read-only property."
        },
        "id":{
            "type":"string",
            "readOnly":true,
            "description":"Id of the email folder. This is a read-only property."
        },
        "currentStatus":{
            "type":"string",
            "description":"The email folder's current status."
        },
        "name":{
            "type":"string",
            "description":"The name of the email folder."
        },
        "description":{
            "type":"string",
            "description":"The description of the email folder."
        },
        "permissions":{
            "type":"string",
            "description":"The permissions for the email folder granted to your current instance. This is a read-only property."
        },
        "createdBy":{
            "type":"string",
            "readOnly":true,
            "description":"The login id of the user who created the email folder."
        },
        "createdAt":{
            "type":"string",
            "readOnly":true,
            "description":"The date and time the email folder was created, expressed in Unix time."
        },
        "updatedBy":{
            "type":"string",
            "readOnly":true,
            "description":"The login id of the user that last updated the email folder."
        },
        "updatedAt":{
            "type":"string",
            "readOnly":true,
            "description":"Unix timestamp for the date and time the email folder was last updated."
        },
        "depth":{
            "type":"string",
            "readOnly":true,
            "description":"Level of detail returned by the request. Eloqua APIs can retrieve entities at three different levels of depth: <code>minimal</code>, <code>partial</code>, and <code>complete</code>. Any other values passed are reset to <code>complete</code> by default. For more information, see <a href='https://docs.oracle.com/cloud/latest/marketingcs_gs/OMCAB/index.html#CSHID=RequestDepth'>Request depth</a>."
        },
        "isSystem":{
            "type":"string",
            "readOnly":true,
            "description":"Whether or not the email folder is a system folder."
        }
    }
}

Back to Top

Response

Supported Media Types

• application/json

200 Response

OK.

Body ()

Root Schema : Folder

Type: object

Title: Folder

Show Source

• createdAt: string
  Read Only: true

  The date and time the email folder was created, expressed in Unix time.
• createdBy: string
  Read Only: true

  The login id of the user who created the email folder.
• currentStatus: string
  The email folder's current status.
• depth: string
  Read Only: true

  Level of detail returned by the request. Eloqua APIs can retrieve entities at three different levels of depth: minimal, partial, and complete. Any other values passed are reset to complete by default. For more information, see Request depth.
• description: string
  The description of the email folder.
• id: string
  Read Only: true

  Id of the email folder. This is a read-only property.
• isSystem: string
  Read Only: true

  Whether or not the email folder is a system folder.
• name: string
  The name of the email folder.
• permissions: string
  The permissions for the email folder granted to your current instance. This is a read-only property.
• type: string
  The asset's type in Eloqua. This is a read-only property.
• updatedAt: string
  Read Only: true

  Unix timestamp for the date and time the email folder was last updated.
• updatedBy: string
  Read Only: true

  The login id of the user that last updated the email folder.

{
    "title":"Folder",
    "properties":{
        "type":{
            "type":"string",
            "description":"The asset's type in Eloqua. This is a read-only property."
        },
        "id":{
            "type":"string",
            "readOnly":true,
            "description":"Id of the email folder. This is a read-only property."
        },
        "currentStatus":{
            "type":"string",
            "description":"The email folder's current status."
        },
        "name":{
            "type":"string",
            "description":"The name of the email folder."
        },
        "description":{
            "type":"string",
            "description":"The description of the email folder."
        },
        "permissions":{
            "type":"string",
            "description":"The permissions for the email folder granted to your current instance. This is a read-only property."
        },
        "createdBy":{
            "type":"string",
            "readOnly":true,
            "description":"The login id of the user who created the email folder."
        },
        "createdAt":{
            "type":"string",
            "readOnly":true,
            "description":"The date and time the email folder was created, expressed in Unix time."
        },
        "updatedBy":{
            "type":"string",
            "readOnly":true,
            "description":"The login id of the user that last updated the email folder."
        },
        "updatedAt":{
            "type":"string",
            "readOnly":true,
            "description":"Unix timestamp for the date and time the email folder was last updated."
        },
        "depth":{
            "type":"string",
            "readOnly":true,
            "description":"Level of detail returned by the request. Eloqua APIs can retrieve entities at three different levels of depth: <code>minimal</code>, <code>partial</code>, and <code>complete</code>. Any other values passed are reset to <code>complete</code> by default. For more information, see <a href='https://docs.oracle.com/cloud/latest/marketingcs_gs/OMCAB/index.html#CSHID=RequestDepth'>Request depth</a>."
        },
        "isSystem":{
            "type":"string",
            "readOnly":true,
            "description":"Whether or not the email folder is a system folder."
        }
    }
}

400 Response

Bad request. See Status Codes for information about other possible HTTP status codes.

401 Response

Unauthorized. See Status Codes for information about other possible HTTP status codes.

403 Response

Forbidden. See Status Codes for information about other possible HTTP status codes.

404 Response

The requested resource was not found. See Status Codes for information about other possible HTTP status codes.

500 Response

The service has encountered an error. See Status Codes for information about other possible HTTP status codes.

Back to Top

Examples

Update the name of the email folder with Id #42:

PUT /api/REST/1.0/assets/email/42
Content-Type: application/json 
			

Request body:

{
    "id":"42",
    "name":"My New Folder Name"
}
			

Response:

{
    "type":"Folder",
    "id":"42",
    "initialId":"42",
    "createdAt":"1172514464",
    "depth":"complete",
    "name":"My New Folder Name",
    "updatedAt":"1432320204",
    "updatedBy":"19",
    "isSystem":"true"
}
			

Back to Top