Notes

List all notes

get

Returns a list of notes ordered chronologically by creation date.

Authorizations

basicAuth

AuthorizationstringRequired

Path parameters

AccountSIDstringRequired

The unique identifier for the account.

CampaignIdintegerRequired

The ID of the campaign to retrieve notes from.

Query parameters

MediaIdintegerOptional

Filter notes by a specific partner account ID.

StartDatestring · date-timeOptional

Retrieve notes created after this date (ISO 8601).

EndDatestring · date-timeOptional

Retrieve notes created before this date (ISO 8601).

Responses

200

A list of note objects.

application/json

get/Advertisers/{AccountSID}/Campaigns/{CampaignId}/Notes

HTTPcURLJavaScriptPython

GET /Advertisers/{AccountSID}/Campaigns/{CampaignId}/Notes HTTP/1.1
Host: api.impact.com
Authorization: Basic username:password
Accept: */*

200

A list of note objects.

{
  "Notes": [
    {
      "Id": 123456,
      "MediaId": 10000,
      "MediaName": "Acme Partner",
      "Creator": "Brand Man",
      "CreationDate": "2020-09-10T10:51:23-07:00",
      "ModificationDate": "2020-10-21T14:51:42-07:00",
      "Content": "Meep Meep",
      "Type": "NONE",
      "Attachments": [
        "/Advertisers/<AccountSID>/Campaigns/1000/Notes/2750/Attachments/1"
      ],
      "Uri": "/Advertisers/<AccountSID>/Campaigns/1000/Notes/123456"
    }
  ]
}

Create a note

post

Creates a new note about a partner. Requires either Content or an Attachment. Use multipart/form-data for file uploads.

Authorizations

basicAuth

AuthorizationstringRequired

Path parameters

AccountSIDstringRequired

The unique identifier for the account.

CampaignIdintegerRequired

The ID of the campaign to create the note in.

Body

multipart/form-data

MediaIdintegerRequired

The partner account ID this note is for.

Example: 10000

ContentstringOptional

The plaintext content of the note. Optional if an Attachment is provided.

Example: Following up on this partner.

Attachmentstring · binaryOptional

An image file to upload as an attachment. Optional if Content is provided.

Typestring · enumOptional

The interaction type for this note.

Default: NONEPossible values:

Responses

200

The note was created successfully.

application/json

StatusstringOptional

Indicates whether the operation was successful.

Example: OK

Uristring · uri-referenceOptional

The unique reference to the affected note.

Example: /Advertisers/<AccountSID>/Campaigns/1000/Notes/2750

post/Advertisers/{AccountSID}/Campaigns/{CampaignId}/Notes

HTTPcURLJavaScriptPython

POST /Advertisers/{AccountSID}/Campaigns/{CampaignId}/Notes HTTP/1.1
Host: api.impact.com
Authorization: Basic username:password
Content-Type: multipart/form-data
Accept: */*
Content-Length: 95

{
  "MediaId": 10000,
  "Content": "Following up on this partner.",
  "Attachment": "binary",
  "Type": "NONE"
}

200

The note was created successfully.

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

Retrieve a note

get

Authorizations

basicAuth

AuthorizationstringRequired

Path parameters

AccountSIDstringRequired

The unique identifier for the account.

CampaignIdintegerRequired

The ID of the campaign the note belongs to.

NoteIdintegerRequired

The unique identifier for the note.

Responses

200

A single note object.

application/json

IdintegerOptional

The unique identifier for the note.

Example: 123456

MediaIdintegerOptional

The unique identifier of the partner this note is about.

Example: 10000

MediaNamestringOptional

The display name of the partner this note is about.

Example: Acme Partner

CreatorstringOptional

The name of the user who created the note.

Example: Brand Man

CreationDatestring · date-timeOptional

The date and time the note was created.

Example: 2020-09-10T10:51:23-07:00

ModificationDatestring · date-timeOptional

The date and time the note was last modified.

Example: 2020-10-21T14:51:42-07:00

ContentstringOptional

The plaintext content of the note.

Example: Meep Meep

Typestring · enumOptional

The interaction type for this note.

Example: NONEPossible values:

Attachmentsstring · uri-reference[]Optional

URIs of file attachments associated with the note.

Example: /Advertisers/<AccountSID>/Campaigns/1000/Notes/2750/Attachments/1

Uristring · uri-referenceOptional

The unique reference to this note in the impact.com API.

Example: /Advertisers/<AccountSID>/Campaigns/1000/Notes/123456

get/Advertisers/{AccountSID}/Campaigns/{CampaignId}/Notes/{NoteId}

HTTPcURLJavaScriptPython

GET /Advertisers/{AccountSID}/Campaigns/{CampaignId}/Notes/{NoteId} HTTP/1.1
Host: api.impact.com
Authorization: Basic username:password
Accept: */*

200

A single note object.

{
  "Id": 123456,
  "MediaId": 10000,
  "MediaName": "Acme Partner",
  "Creator": "Brand Man",
  "CreationDate": "2020-09-10T10:51:23-07:00",
  "ModificationDate": "2020-10-21T14:51:42-07:00",
  "Content": "Meep Meep",
  "Type": "NONE",
  "Attachments": [
    "/Advertisers/<AccountSID>/Campaigns/1000/Notes/2750/Attachments/1"
  ],
  "Uri": "/Advertisers/<AccountSID>/Campaigns/1000/Notes/123456"
}

Update a note

put

Updates specific note fields. Parameters not provided remain unchanged.

Authorizations

basicAuth

AuthorizationstringRequired

Path parameters

AccountSIDstringRequired

The unique identifier for the account.

CampaignIdintegerRequired

The ID of the campaign the note belongs to.

NoteIdintegerRequired

The unique identifier for the note to update.

Body

multipart/form-data

ContentstringOptional

The new plaintext content for the note.

Example: Updated note content.

Typestring · enumOptional

The interaction type for this note.

Possible values:

AttachmentsAddstring · binaryOptional

An image file to add as a new attachment.

AttachmentsRemovestringOptional

impact.com internal name for the file to be deleted.

Example: 1,2

Responses

200

The note was updated successfully.

application/json

StatusstringOptional

Indicates whether the operation was successful.

Example: OK

Uristring · uri-referenceOptional

The unique reference to the affected note.

Example: /Advertisers/<AccountSID>/Campaigns/1000/Notes/2750

put/Advertisers/{AccountSID}/Campaigns/{CampaignId}/Notes/{NoteId}

HTTPcURLJavaScriptPython

PUT /Advertisers/{AccountSID}/Campaigns/{CampaignId}/Notes/{NoteId} HTTP/1.1
Host: api.impact.com
Authorization: Basic username:password
Content-Type: multipart/form-data
Accept: */*
Content-Length: 102

{
  "Content": "Updated note content.",
  "Type": "EMAIL",
  "AttachmentsAdd": "binary",
  "AttachmentsRemove": "1,2"
}

200

The note was updated successfully.

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

Delete a note

delete

Authorizations

basicAuth

AuthorizationstringRequired

Path parameters

AccountSIDstringRequired

The unique identifier for the account.

CampaignIdintegerRequired

The ID of the campaign the note belongs to.

NoteIdintegerRequired

The unique identifier for the note to delete.

Responses

200

The note was deleted successfully.

application/json

StatusstringOptional

Indicates that the note was deleted.

Example: DELETED

delete/Advertisers/{AccountSID}/Campaigns/{CampaignId}/Notes/{NoteId}

HTTPcURLJavaScriptPython

DELETE /Advertisers/{AccountSID}/Campaigns/{CampaignId}/Notes/{NoteId} HTTP/1.1
Host: api.impact.com
Authorization: Basic username:password
Accept: */*

200

The note was deleted successfully.

{
  "Status": "DELETED"
}