Partner Groups

List All Partner Groups

get

Returns a list of all partner groups for a specific campaign.

Path parameters

AccountSIDstringRequired

Your unique Account SID.

CampaignIdintegerRequired

The ID of the campaign to retrieve partner groups from.

Responses

200

A paginated list of partner group objects.

application/json

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

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

200

A paginated 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 partner group and optionally adds partners to it.

Path parameters

AccountSIDstringRequired

Your unique Account SID.

CampaignIdintegerRequired

The ID of the campaign to create the group in.

Body

NamestringRequired

The name for the new partner group.

Example: Acme Top Partners

MediaPartnersstringOptional

A comma-separated list of MediaPartnerId values to add to the group.

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

POST /Advertisers/{AccountSID}/Campaigns/{CampaignId}/MediaPartnerGroups HTTP/1.1
Host: api.impact.com
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

Retrieves the details of a single partner group by its ID.

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}

GET /Advertisers/{AccountSID}/Campaigns/{CampaignId}/MediaPartnerGroups/{PartnerGroupId} HTTP/1.1
Host: api.impact.com
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

Updates a partner group's name and membership by adding or removing partners.

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

NamestringOptional

The new name for the partner group.

Example: Acme Top Partners

MediaPartnersAddstringOptional

A comma-separated list of MediaPartnerId values to add.

Example: 2552843

MediaPartnersRemovestringOptional

A comma-separated list of MediaPartnerId values 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}

PUT /Advertisers/{AccountSID}/Campaigns/{CampaignId}/MediaPartnerGroups/{PartnerGroupId} HTTP/1.1
Host: api.impact.com
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

Deletes a partner group. Partners will no longer be associated with the deleted group.

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 successfully deleted.

application/json

StatusstringOptional

Indicates that the partner group was deleted.

Example: DELETED

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

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

200

The partner group was successfully deleted.

{
  "Status": "DELETED"
}