Update an Existing Attachment

Method: PUT

Url: /Attachments
Header: DPApiAuthenticationToken={YOUR_API_TOKEN}

Query String: None

Request Body:

Parameter Name Data Type Remarks
Parameter Name:

AttachmentID (required)

Data Type:

Integer

Remarks:

The ID of the attachment to be updated

Parameter Name:

ShortDescription (required)

Data Type:

String

Remarks:

The description to be changed.

Column Name:

CustomFields

Data Type:

List<CustomField>

Remarks:

List of custom fields (key-value pair) for this record

Request Example:
PUT "https://api.dataprise.com/api/v1/Attachments/"

Header: "DPApiAuthenticationToken=abcxyz0123456789"

Body:
		{
			"AttachmentID": 1234,
			"ShortDescription": "Test upload from API - Updated",
			"CustomFields": [{"FieldLabel": "Source", "FieldValue":"Email"}]
		}
		  

Response:

The API will return the response as under:

Property Data Type Remarks
Parameter Name:

Status

Data Type:

String

Description:

Status of the request. Either "Success" or "Failure"

Parameter Name:

Message

Data Type:

String

Description:

Error messages if the request failed (i.e. Status = "Failure")

Property:

Id

Data Type:

Integer

Description:

The ID of the updated record if the request succeeded (i.e. Status = "Success")

Sample Response:
		{
			"Status": "Success",
			"Message": "",
			"Id": 1234
		}