Jump to

• Request
• Response
• Examples

Update an image

put

/api/REST/1.0/assets/image/{id}

Updates the image 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 image to update.

Body ()

The request body defines the details of the image to be created.

Root Schema : ImageFile

Type: object

Title: ImageFile

Show Source

• createdAt: string
  Read Only: true

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

  The login id of the user who created the image.
• currentStatus: string
  The image'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 image.
• fullImageUrl: string
  The image's complete URL. This is a read-only property.
• id: string
  Read Only: true

  Id of the image. This is a read-only property.
• name: string
  The name of the image.
• permissions: string
  The permissions for the image granted to your current instance. This is a read-only property.
• size: object Size
  Title: Size
• thumbnailUrl: string
  The image's thumbnail URL. 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 image was last updated.
• updatedBy: string
  Read Only: true

  The login id of the user that last updated the image.

{
    "title":"ImageFile",
    "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 image. This is a read-only property."
        },
        "currentStatus":{
            "type":"string",
            "description":"The image's current status."
        },
        "name":{
            "type":"string",
            "description":"The name of the image."
        },
        "description":{
            "type":"string",
            "description":"The description of the image."
        },
        "permissions":{
            "type":"string",
            "description":"The permissions for the image 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 image."
        },
        "createdAt":{
            "type":"string",
            "readOnly":true,
            "description":"The date and time the image was created, expressed in Unix time."
        },
        "updatedBy":{
            "type":"string",
            "readOnly":true,
            "description":"The login id of the user that last updated the image."
        },
        "updatedAt":{
            "type":"string",
            "readOnly":true,
            "description":"Unix timestamp for the date and time the image 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>."
        },
        "fullImageUrl":{
            "type":"string",
            "description":"The image's complete URL. This is a read-only property."
        },
        "size":{
            "$ref":"#/definitions/SizeRest10",
            "description":"The size of the image. Contains 3 fields: type, width and height. \"type\" should be set to \"Size\", and width and height can be set to the image's desired dimensions."
        },
        "thumbnailUrl":{
            "type":"string",
            "description":"The image's thumbnail URL. This is a read-only property."
        }
    }
}

Nested Schema : Size

Type: object

Title: Size

Show Source

• type: string

{
    "title":"Size",
    "properties":{
        "type":{
            "type":"string"
        }
    }
}

Back to Top

Response

Supported Media Types

• application/json

200 Response

OK.

Body ()

Root Schema : ImageFile

Type: object

Title: ImageFile

Show Source

• createdAt: string
  Read Only: true

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

  The login id of the user who created the image.
• currentStatus: string
  The image'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 image.
• fullImageUrl: string
  The image's complete URL. This is a read-only property.
• id: string
  Read Only: true

  Id of the image. This is a read-only property.
• name: string
  The name of the image.
• permissions: string
  The permissions for the image granted to your current instance. This is a read-only property.
• size: object Size
  Title: Size
• thumbnailUrl: string
  The image's thumbnail URL. 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 image was last updated.
• updatedBy: string
  Read Only: true

  The login id of the user that last updated the image.

{
    "title":"ImageFile",
    "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 image. This is a read-only property."
        },
        "currentStatus":{
            "type":"string",
            "description":"The image's current status."
        },
        "name":{
            "type":"string",
            "description":"The name of the image."
        },
        "description":{
            "type":"string",
            "description":"The description of the image."
        },
        "permissions":{
            "type":"string",
            "description":"The permissions for the image 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 image."
        },
        "createdAt":{
            "type":"string",
            "readOnly":true,
            "description":"The date and time the image was created, expressed in Unix time."
        },
        "updatedBy":{
            "type":"string",
            "readOnly":true,
            "description":"The login id of the user that last updated the image."
        },
        "updatedAt":{
            "type":"string",
            "readOnly":true,
            "description":"Unix timestamp for the date and time the image 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>."
        },
        "fullImageUrl":{
            "type":"string",
            "description":"The image's complete URL. This is a read-only property."
        },
        "size":{
            "$ref":"#/definitions/SizeRest10",
            "description":"The size of the image. Contains 3 fields: type, width and height. \"type\" should be set to \"Size\", and width and height can be set to the image's desired dimensions."
        },
        "thumbnailUrl":{
            "type":"string",
            "description":"The image's thumbnail URL. This is a read-only property."
        }
    }
}

Nested Schema : Size

Type: object

Title: Size

Show Source

• type: string

{
    "title":"Size",
    "properties":{
        "type":{
            "type":"string"
        }
    }
}

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 and folder of the image with Id #124:

PUT /api/REST/1.0/assets/image/124
Content-Type: application/json 
			

Request body:

{
  "id": "124",
  "name": "Unicorn.jpg",
  "folderId": "3628"
}
			

Response:

{
  "type": "ImageFile",
  "id": "124",
  "initialId": "25",
  "createdAt": "1471368211",
  "createdBy": "9",
  "depth": "complete",
  "folderId": "3628",
  "name": "Unicorn.jpg",
  "updatedAt": "1471370423",
  "updatedBy": "9",
  "fullImageUrl": "/EloquaImages/clients/TestInstance/{6f1ee4ee-ef1f-491d-967c-5cca14fe2721}_496_3138737-Unicorn.jpg",
  "size": {
    "type": "Size",
    "width": "386",
    "height": "387"
  },
  "thumbnailUrl": "/EloquaImages/clients/TestInstance/imagethumbnails/{6f1ee4ee-ef1f-491d-967c-5cca14fe2721}_496_3138737-Unicorn.jpg"
}
			

Back to Top