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

Create a note

Creates a new note.

Parameters

MediaId required

The partner account Id that this note is for.

Attachment required

Name of the image file to upload. Including this parameter requires adding the header Content-Type: multipart/form-data and the parameter example.png=@"/path/to/an/example.png", which specifies the location to the image file being updated. See the example request cURL. Is optional if the Content parameter is used.

Content required

The plaintext content of the note. Is optional if the Attachment parameter is used.

Type optional

What type of interaction caused the note. Defaults to NONE if not expressed.

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 created note. Returns an error if create parameters are invalid or if a required parameter is missing.

Example Request

curl 'https://api.impact.com/Advertisers/<AccountSID>/Campaigns/1000/Notes' \
  -X POST \
  -u '<AccountSID>:<AuthToken>' \
  -H 'Accept: application/json' \
  -H 'Content-Type: multipart/form-data' \
  -d 'Attachment=image.png' \
  -d 'image.png=@"/path/to/an/image.png"' \
  -d 'Content=This is a note.' \
  -d 'MediaId=10000' \
  -d 'Type=IM'

Example Response

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