Partner Groups

List all partner groups

get

Returns a list of all partner groups associated with the specified campaign.

Authorizations

basicAuth

AuthorizationstringRequired

Path parameters

AccountSIDstringRequired

The unique identifier for the account.

CampaignIdintegerRequired

The ID of the campaign to retrieve partner groups from.

Responses

200

A list of partner group objects.

application/json

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

HTTPcURLJavaScriptPython

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

200

A list of partner group objects.

{
  "Groups": [
    {
      "Id": "99999",
      "Name": "Acme Top Partners",
      "MediaPartners": [
        {
          "PartnerId": "2552842",
          "PartnerName": "Wile E. Coyote Facebook",
          "PartnerUri": "/Advertisers/<AccountSID>/MediaPartners/2552842"
        }
      ],
      "Uri": "/Advertisers/<AccountSID>/Campaigns/1000/MediaPartnerGroups/99999"
    }
  ]
}

Create a partner group

post

Creates a new private partner group for organizing partners.

Authorizations

basicAuth

AuthorizationstringRequired

Path parameters

AccountSIDstringRequired

The unique identifier for the account.

CampaignIdintegerRequired

The ID of the campaign to create the group in.

Body

application/x-www-form-urlencoded

NamestringRequired

The display name for the partner group.

Example: Acme Top Partners

MediaPartnersstringOptional

Comma-separated list of MediaPartnerId values to add.

Example: 2552842,2552843

Responses

200

The partner group was created successfully.

application/json

StatusstringOptional

Indicates whether the operation was successful.

Example: OK

Uristring · uri-referenceOptional

The unique reference to the affected partner group.

Example: /Advertisers/<AccountSID>/Campaigns/8882/MediaPartnerGroups/12345

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

HTTPcURLJavaScriptPython

POST /Advertisers/{AccountSID}/Campaigns/{CampaignId}/MediaPartnerGroups HTTP/1.1
Host: api.impact.com
Authorization: Basic username:password
Content-Type: application/x-www-form-urlencoded
Accept: */*
Content-Length: 62

"Name='Acme Top Partners'&MediaPartners='2552842,2552843'"

200

The partner group was created successfully.

{
  "Status": "OK",
  "Uri": "/Advertisers/<AccountSID>/Campaigns/8882/MediaPartnerGroups/12345"
}

Retrieve a partner group

get

Authorizations

basicAuth

AuthorizationstringRequired

Path parameters

AccountSIDstringRequired

The unique identifier for the account.

CampaignIdintegerRequired

The ID of the campaign the group belongs to.

PartnerGroupIdintegerRequired

The unique identifier for the partner group.

Responses

200

A single partner group object.

application/json

IdstringOptional

The unique identifier for the partner group.

Example: 99999

NamestringOptional

The partner group's name. Only visible to you and other account members, not visible to partners.

Example: Acme Top Partners

Uristring · uri-referenceOptional

The unique reference to this partner group in the impact.com API.

Example: /Advertisers/<AccountSID>/Campaigns/1000/MediaPartnerGroups/99999

get/Advertisers/{AccountSID}/Campaigns/{CampaignId}/MediaPartnerGroups/{PartnerGroupId}

HTTPcURLJavaScriptPython

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

200

A single partner group object.

{
  "Id": "99999",
  "Name": "Acme Top Partners",
  "MediaPartners": [
    {
      "PartnerId": "2552842",
      "PartnerName": "Wile E. Coyote Facebook",
      "PartnerUri": "/Advertisers/<AccountSID>/MediaPartners/2552842"
    }
  ],
  "Uri": "/Advertisers/<AccountSID>/Campaigns/1000/MediaPartnerGroups/99999"
}

Update a partner group

put

Update group metadata or modify membership by adding or removing partners.

Authorizations

basicAuth

AuthorizationstringRequired

Path parameters

AccountSIDstringRequired

The unique identifier for the account.

CampaignIdintegerRequired

The ID of the campaign the group belongs to.

PartnerGroupIdintegerRequired

The unique identifier for the partner group to update.

Body

application/x-www-form-urlencoded

NamestringOptional

New name for the partner group.

Example: Acme Top Partners

MediaPartnersAddstringOptional

Comma-separated list of partner IDs to add.

Example: 2552843

MediaPartnersRemovestringOptional

Comma-separated list of partner IDs to remove.

Example: 2552842

Responses

200

The partner group was updated successfully.

application/json

StatusstringOptional

Indicates whether the operation was successful.

Example: OK

Uristring · uri-referenceOptional

The unique reference to the affected partner group.

Example: /Advertisers/<AccountSID>/Campaigns/8882/MediaPartnerGroups/12345

put/Advertisers/{AccountSID}/Campaigns/{CampaignId}/MediaPartnerGroups/{PartnerGroupId}

HTTPcURLJavaScriptPython

PUT /Advertisers/{AccountSID}/Campaigns/{CampaignId}/MediaPartnerGroups/{PartnerGroupId} HTTP/1.1
Host: api.impact.com
Authorization: Basic username:password
Content-Type: application/x-www-form-urlencoded
Accept: */*
Content-Length: 89

"Name='Acme Top Partners'&MediaPartnersAdd='2552843'&MediaPartnersRemove='2552842'"

200

The partner group was updated successfully.

{
  "Status": "OK",
  "Uri": "/Advertisers/<AccountSID>/Campaigns/8882/MediaPartnerGroups/12345"
}

Delete a partner group

delete

Authorizations

basicAuth

AuthorizationstringRequired

Path parameters

AccountSIDstringRequired

The unique identifier for the account.

CampaignIdintegerRequired

The ID of the campaign the group belongs to.

PartnerGroupIdintegerRequired

The unique identifier for the partner group to delete.

Responses

200

The partner group was deleted successfully.

application/json

StatusstringOptional

Indicates that the partner group was deleted.

Example: DELETED

delete/Advertisers/{AccountSID}/Campaigns/{CampaignId}/MediaPartnerGroups/{PartnerGroupId}

HTTPcURLJavaScriptPython

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

200

The partner group was deleted successfully.

{
  "Status": "DELETED"
}