Notes

List All Notes

get

Returns a list of notes for a specific campaign, with options for filtering by partner and date.

Path parameters

AccountSIDstringRequired

Your unique Account SID.

CampaignIdintegerRequired

The ID of the campaign the notes belong to.

Query parameters

MediaIdintegerOptional

Filter notes for a specific partner account ID.

StartDatestring · date-timeOptional

The start of the date range to filter notes by their creation date.

EndDatestring · date-timeOptional

The end of the date range to filter notes by their creation date.

Responses

200

A paginated 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
Accept: */*

200

A paginated 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": "EMAIL",
      "Attachments": [
        "/Advertisers/<AccountSID>/Campaigns/1000/Notes/2750/Attachments/1"
      ],
      "Uri": "/Advertisers/<AccountSID>/Campaigns/1000/Notes/123456"
    }
  ]
}

Create a Note

post

Creates a new note for a partner. Either Content or an Attachment is required.

Path parameters

AccountSIDstringRequired

Your unique Account SID.

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.

Typestring · enumOptional

The interaction type for this note.

Possible values:

Attachmentstring · binaryOptional

An image file to attach to the note.

Responses

200

The request was successful.

application/json

StatusstringOptional

Indicates whether the operation was successful.

Example: OK

Uristring · uri-referenceOptional

The unique reference to the affected note.

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

HTTPcURLJavaScriptPython

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

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

200

The request was successful.

{
  "Status": "OK",
  "Uri": "../folder"
}

Retrieve a Note

get

Retrieves the details of a single, existing note by its unique ID.

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.

Possible 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
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": "EMAIL",
  "Attachments": [
    "/Advertisers/<AccountSID>/Campaigns/1000/Notes/2750/Attachments/1"
  ],
  "Uri": "/Advertisers/<AccountSID>/Campaigns/1000/Notes/123456"
}

Update a Note

put

Updates the specified note, allowing for changes to content and attachments.

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.

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

A new image file to attach.

AttachmentsRemovestringOptional

The name of an existing attachment to remove.

Example: 1,2

Responses

200

The request was successful.

application/json

StatusstringOptional

Indicates whether the operation was successful.

Example: OK

Uristring · uri-referenceOptional

The unique reference to the affected note.

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

HTTPcURLJavaScriptPython

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

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

200

The request was successful.

{
  "Status": "OK",
  "Uri": "../folder"
}

Delete a Note

delete

Permanently deletes a note. This cannot be undone.

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

The resource was successfully deleted.

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
Accept: */*

200

The resource was successfully deleted.

{
  "Status": "DELETED"
}