HomeGuidesAPI ReferenceAPI Changelog
Log In
API Reference
Start typing to search…

Update a note

Updates the specified note by setting the values of the parameters passed. Any parameters not provided will be left unchanged.

Parameters

AttachmentsAdd optional

Name of the image file to upload. Including this parameter requires adding Content-Type: multipart/form-data to the call and an additional parameter that specifies the location to this file. See the cURL (Form Data) example.

AttachmentsRemove optional

impact.com's name for the image file to be deleted, which is found when the note is retrieved. Including this parameter requires adding Content-Type: multipart/form-data to the call. See the cURL (Form Data) example.

Content optional

The note to be made.

Type optional

What type of partner interaction caused the note.

View possible enum values
EMAILThe noted interaction is an email exchange.
IMThe noted interaction is a text or instant message conversation.
NONEThe note is not founded on an interaction with the partner.
PHONEThe noted interaction is a phone call.

Returns

Returns the status of the request and the URI of the newly updated note. Returns an error if update parameters are invalid.

Example Request

curl 'https://api.impact.com/Advertisers/<AccountSID>/Campaigns/1000/Notes/123456' \
  -X PUT \
  -u '<AccountSID>:<AuthToken>' \
  -H 'Accept: application/json' \
  -H 'Content-Type: multipart/form-data' \
  -d 'Content="This is a note"' \
  -d 'Type=EMAIL' \
  -d 'AttachmentsAdd=image.png' \
  -d 'image.png=@"/path/to/an/image.png"' \
  -d 'AttachmentsRemove=crm_7654321_123a456b-cd7e-8f90-1gh2-34ijk5l67lmn'

Example Response

{
  "Status": "OK",
  "Uri": "/Advertisers/<AccountSID>/Campaigns/1000/Notes/123456"
}