Ctrlk
Help CenterContact Support
For the complete documentation index, see llms.txt. This page is also available as Markdown.

Contracts

List All Contracts

get

Returns a list of your contracts for a specific campaign, with options for filtering. If no status is specified, only ACTIVE contracts are returned.

Path parameters
AccountSIDstringRequiredExample: IRATkFHXxJ27tnkWnkS3
CampaignIdintegerRequiredExample: 1000
Query parameters
DateLastUpdatedBeforestring · date-timeOptional

Return contracts updated before a specific date and time (ISO-8601).

DateLastUpdatedAfterstring · date-timeOptional

Return contracts updated after a specific date and time (ISO-8601).

StartDateBeforestring · date-timeOptional

Return contracts that start before a specific date and time (ISO-8601).

StartDateAfterstring · date-timeOptional

Return contracts that start after a specific date and time (ISO-8601).

EndDateBeforestring · date-timeOptional

Return contracts that end before a specific date and time (ISO-8601).

EndDateAfterstring · date-timeOptional

Return contracts that end after a specific date and time (ISO-8601).

PartnerIdintegerOptional

Return contracts for a specific partner.

SignatorystringOptional

Return contracts with a particular brand or partner signatory.

Statusstring · enumOptional

Return contracts with a specific status. Defaults to ACTIVE if not specified.

Possible values:
TemplateIdintegerOptional

Return contracts sourced from a specific Template Terms ID.

Responses
200

A paginated list of contract objects.

application/json
get/Advertisers/{AccountSID}/Campaigns/{CampaignId}/Contracts
GET /Advertisers/{AccountSID}/Campaigns/{CampaignId}/Contracts HTTP/1.1
Host: api.impact.com
Accept: */*
200

A paginated list of contract objects.

{
  "Contracts": [
    {
      "Id": "S-7777777",
      "PartnerId": 10000,
      "PartnerValue1": "",
      "Status": "ACTIVE",
      "StartDate": "2021-01-20T00:00:00-08:00",
      "EndDate": "",
      "BrandSignatory": "Justin Case",
      "BrandSignatoryDate": "2021-01-19T23:51:01-08:00",
      "PartnerSignatory": "Partner Person",
      "PartnerSignatoryDate": "2021-01-19T23:51:01-08:00",
      "DateCreated": "2021-01-19T23:51:01-08:00",
      "DateLastUpdated": "2021-01-19T23:51:01-08:00",
      "TemplateTerms": {
        "TemplateId": 99999,
        "VersionId": 6,
        "Name": "ACME Public Terms",
        "Labels": [
          "text"
        ],
        "Currency": "USD",
        "EventPayouts": [
          {
            "EventTypeId": 18500,
            "EventTypeName": "Online Sale",
            "EventCategory": "SALE",
            "DefaultPayout": 10,
            "DefaultPayoutRate": 15,
            "PayoutLevel": "ITEM",
            "PayoutGroups": [
              {
                "Id": "ab12c3d4-5e6f-7g89-01h2-345ijk6lmn78",
                "Rank": 1,
                "Rules": [
                  {
                    "Variable": "CUSTOMER_COUNTRY",
                    "Operator": "IS",
                    "Values": [
                      "text"
                    ]
                  }
                ],
                "Payout": 1,
                "PayoutRate": 15,
                "Limits": [
                  {}
                ],
                "Tiers": [
                  {}
                ]
              }
            ]
          }
        ],
        "PromotionalTerms": [
          {
            "TermsName": "Custom Terms",
            "TermsType": "CUSTOM",
            "TermsContent": "<p>Custom promotional terms content.</p>",
            "TermsPdfUri": "../folder"
          }
        ]
      },
      "ScheduledTerms": [
        {
          "Status": "ACTIVE",
          "Name": "Black Friday Special Rates",
          "StartDate": "2026-11-27T00:00:00-08:00",
          "EndDate": "2026-11-30T23:59:59-08:00",
          "Repeat": {
            "Days": [
              "2026-01-01"
            ],
            "StartTime": "09:00:00",
            "EndTime": "17:00:00"
          },
          "EventPayouts": [
            {
              "EventTypeId": 18500,
              "EventTypeName": "Online Sale",
              "EventCategory": "SALE",
              "DefaultPayout": 10,
              "DefaultPayoutRate": 15,
              "PayoutLevel": "ITEM",
              "PayoutGroups": [
                {
                  "Id": "ab12c3d4-5e6f-7g89-01h2-345ijk6lmn78",
                  "Rank": 1,
                  "Rules": [
                    {
                      "Variable": "CUSTOMER_COUNTRY",
                      "Operator": "IS",
                      "Values": [
                        "text"
                      ]
                    }
                  ],
                  "Payout": 1,
                  "PayoutRate": 15,
                  "Limits": [
                    {}
                  ],
                  "Tiers": [
                    {}
                  ]
                }
              ]
            }
          ]
        }
      ],
      "CampaignTerms": [
        {
          "Name": "Product Boost Campaign 1",
          "Id": "1234",
          "StartDate": "2025-03-28T00:00:00-07:00",
          "EndDate": "2025-03-29T00:00:00-07:00",
          "EventPayouts": [
            {
              "EventTypeId": 18500,
              "EventTypeName": "Online Sale",
              "EventCategory": "SALE",
              "DefaultPayout": 10,
              "DefaultPayoutRate": 15,
              "PayoutLevel": "ITEM",
              "PayoutGroups": [
                {
                  "Id": "ab12c3d4-5e6f-7g89-01h2-345ijk6lmn78",
                  "Rank": 1,
                  "Rules": [
                    {
                      "Variable": "CUSTOMER_COUNTRY",
                      "Operator": "IS",
                      "Values": [
                        "text"
                      ]
                    }
                  ],
                  "Payout": 1,
                  "PayoutRate": 15,
                  "Limits": [
                    {}
                  ],
                  "Tiers": [
                    {}
                  ]
                }
              ]
            }
          ]
        }
      ],
      "HasCampaignTerms": true,
      "PdfUri": "/Advertisers/<AccountSID>/Campaigns/1000/Contracts/S-7777777/Download",
      "Uri": "/Advertisers/<AccountSID>/Campaigns/1000/Contracts/S-7777777"
    }
  ]
}

Get Contract Details

get

Retrieves the object of an existing contract, including details on any associated Creator, Performance, or Product Boost campaigns.

Path parameters
AccountSIDstringRequiredExample: IRATkFHXxJ27tnkWnkS3
CampaignIdintegerRequiredExample: 1000
ContractIdstringRequired

The unique identifier for the contract.

Example: S-7777777
Responses
200

A single contract object.

application/json
IdstringOptional

The unique identifier for the contract.

Example: S-7777777
PartnerIdintegerOptional

The unique identifier of the partner the contract is with.

Example: 10000
PartnerValue1stringOptional

A custom value associated with the partner.

Statusstring · enumOptional

The current status of the contract.

Example: ACTIVEPossible values:
StartDatestring · date-timeOptional

The date and time the contract becomes active.

Example: 2021-01-20T00:00:00-08:00
EndDatestring · date-time · nullableOptional

The date and time the contract expires. Null for open-ended contracts.

BrandSignatorystringOptional

The name of the brand representative who signed the contract.

Example: Justin Case
BrandSignatoryDatestring · date-timeOptional

The date and time the brand signed the contract.

Example: 2021-01-19T23:51:01-08:00
PartnerSignatorystringOptional

The name of the partner representative who signed the contract.

Example: Partner Person
PartnerSignatoryDatestring · date-timeOptional

The date and time the partner signed the contract.

Example: 2021-01-19T23:51:01-08:00
DateCreatedstring · date-timeOptional

The date and time the contract was created.

Example: 2021-01-19T23:51:01-08:00
DateLastUpdatedstring · date-timeOptional

The date and time the contract was last updated.

Example: 2021-01-19T23:51:01-08:00
HasCampaignTermsbooleanOptional

Indicates whether the contract has associated campaign terms.

Example: true
PdfUristring · uri-referenceOptional

The URI to download the contract as a PDF.

Example: /Advertisers/<AccountSID>/Campaigns/1000/Contracts/S-7777777/Download
Uristring · uri-referenceOptional

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

Example: /Advertisers/<AccountSID>/Campaigns/1000/Contracts/S-7777777
get/Advertisers/{AccountSID}/Campaigns/{CampaignId}/Contracts/{ContractId}
GET /Advertisers/{AccountSID}/Campaigns/{CampaignId}/Contracts/{ContractId} HTTP/1.1
Host: api.impact.com
Accept: */*
200

A single contract object.

{
  "Id": "S-7777777",
  "PartnerId": 10000,
  "PartnerValue1": "",
  "Status": "ACTIVE",
  "StartDate": "2021-01-20T00:00:00-08:00",
  "EndDate": "",
  "BrandSignatory": "Justin Case",
  "BrandSignatoryDate": "2021-01-19T23:51:01-08:00",
  "PartnerSignatory": "Partner Person",
  "PartnerSignatoryDate": "2021-01-19T23:51:01-08:00",
  "DateCreated": "2021-01-19T23:51:01-08:00",
  "DateLastUpdated": "2021-01-19T23:51:01-08:00",
  "TemplateTerms": {
    "TemplateId": 99999,
    "VersionId": 6,
    "Name": "ACME Public Terms",
    "Labels": [
      "text"
    ],
    "Currency": "USD",
    "EventPayouts": [
      {
        "EventTypeId": 18500,
        "EventTypeName": "Online Sale",
        "EventCategory": "SALE",
        "DefaultPayout": 10,
        "DefaultPayoutRate": 15,
        "PayoutLevel": "ITEM",
        "PayoutGroups": [
          {
            "Id": "ab12c3d4-5e6f-7g89-01h2-345ijk6lmn78",
            "Rank": 1,
            "Rules": [
              {
                "Variable": "CUSTOMER_COUNTRY",
                "Operator": "IS",
                "Values": [
                  "text"
                ]
              }
            ],
            "Payout": 1,
            "PayoutRate": 15,
            "Limits": [
              {}
            ],
            "Tiers": [
              {}
            ]
          }
        ]
      }
    ],
    "PromotionalTerms": [
      {
        "TermsName": "Custom Terms",
        "TermsType": "CUSTOM",
        "TermsContent": "<p>Custom promotional terms content.</p>",
        "TermsPdfUri": "../folder"
      }
    ]
  },
  "ScheduledTerms": [
    {
      "Status": "ACTIVE",
      "Name": "Black Friday Special Rates",
      "StartDate": "2026-11-27T00:00:00-08:00",
      "EndDate": "2026-11-30T23:59:59-08:00",
      "Repeat": {
        "Days": [
          "2026-01-01"
        ],
        "StartTime": "09:00:00",
        "EndTime": "17:00:00"
      },
      "EventPayouts": [
        {
          "EventTypeId": 18500,
          "EventTypeName": "Online Sale",
          "EventCategory": "SALE",
          "DefaultPayout": 10,
          "DefaultPayoutRate": 15,
          "PayoutLevel": "ITEM",
          "PayoutGroups": [
            {
              "Id": "ab12c3d4-5e6f-7g89-01h2-345ijk6lmn78",
              "Rank": 1,
              "Rules": [
                {
                  "Variable": "CUSTOMER_COUNTRY",
                  "Operator": "IS",
                  "Values": [
                    "text"
                  ]
                }
              ],
              "Payout": 1,
              "PayoutRate": 15,
              "Limits": [
                {}
              ],
              "Tiers": [
                {}
              ]
            }
          ]
        }
      ]
    }
  ],
  "CampaignTerms": [
    {
      "Name": "Product Boost Campaign 1",
      "Id": "1234",
      "StartDate": "2025-03-28T00:00:00-07:00",
      "EndDate": "2025-03-29T00:00:00-07:00",
      "EventPayouts": [
        {
          "EventTypeId": 18500,
          "EventTypeName": "Online Sale",
          "EventCategory": "SALE",
          "DefaultPayout": 10,
          "DefaultPayoutRate": 15,
          "PayoutLevel": "ITEM",
          "PayoutGroups": [
            {
              "Id": "ab12c3d4-5e6f-7g89-01h2-345ijk6lmn78",
              "Rank": 1,
              "Rules": [
                {
                  "Variable": "CUSTOMER_COUNTRY",
                  "Operator": "IS",
                  "Values": [
                    "text"
                  ]
                }
              ],
              "Payout": 1,
              "PayoutRate": 15,
              "Limits": [
                {}
              ],
              "Tiers": [
                {}
              ]
            }
          ]
        }
      ]
    }
  ],
  "HasCampaignTerms": true,
  "PdfUri": "/Advertisers/<AccountSID>/Campaigns/1000/Contracts/S-7777777/Download",
  "Uri": "/Advertisers/<AccountSID>/Campaigns/1000/Contracts/S-7777777"
}

Accept a Pending Contract

post

Accepts a pending partner contract proposal. Use this endpoint by passing the program and contract IDs. You can also accept the partner into one or more additional programs of the same account in the same request by passing additionalProgramIds. To identify contracts currently waiting to be actioned, filter your contract list with the Status=PENDING parameter.

Additional programs

Enrollments into additional programs are processed asynchronously and are not reflected in the response. All program IDs in additionalProgramIds must belong to the same account as the program in the request path.

Decision precedence and conflict handling

You can accept a contract proposal using multiple channels — the Applications UI, automated workflows, or impact ai — while an API request is in flight.

The "first-in" rule

  • Finality: Once you accept a contract proposal through any channel, that decision is final.

  • Conflict resolution: If multiple determinations are submitted for the same contractId, the system honors the first determination received based on the server timestamp. All subsequent or conflicting submissions are ignored.

Path parameters
AccountSIDstringRequired

Your account SID.

Example: IRATkFHXxJ27tnkWnkS3
ProgramIdintegerRequired

The unique identifier of the program the contract belongs to.

Example: 8575
Body
contractIdstringRequired

The unique identifier of the pending contract to accept.

Example: P-25070000
additionalProgramIdsinteger[]Optional

The list of program IDs to accept the partner into. Include the program ID from the request path, along with any other programs of the same account. The partner is contracted to the Public Terms of each program.

Example: [8575,8576,8577]
groupIdstringOptional

The unique identifier of the partner group to which the accepted partner will be added. Provide multiple IDs as a comma-separated string if adding to more than one group.

Example: 1234
Responses
200

The contract was successfully accepted.

application/json
Statusstring · enumOptional

Indicates whether the decision was successfully recorded.

Example: OKPossible values:
post/Advertisers/{AccountSID}/Programs/{ProgramId}/Contracts
POST /Advertisers/{AccountSID}/Programs/{ProgramId}/Contracts HTTP/1.1
Host: api.impact.com
Content-Type: application/json
Accept: */*
Content-Length: 67

{
  "contractId": "P-25070000",
  "additionalProgramIds": [
    8575,
    8576,
    8577
  ]
}
{
  "Status": "OK"
}

Decline a Pending Contract

delete

Declines a pending partner contract proposal. Use this endpoint by passing the program and contract IDs. To identify contracts currently awaiting action, filter your contract list with the Status=PENDING parameter.

Decision precedence and conflict handling

You can decline a contract proposal using multiple channels — the Applications UI, automated workflows, or impact ai — while an API request is in flight.

The "first-in" rule

  • Finality: Once you decline a contract proposal through any channel, that decision is final.

  • Conflict resolution: If multiple determinations are submitted for the same contractId, the system honors the first determination received based on the server timestamp. All subsequent or conflicting submissions are ignored.

Path parameters
AccountSIDstringRequired

Your account SID.

Example: IRATkFHXxJ27tnkWnkS3
ProgramIdintegerRequired

The unique identifier of the program the contract belongs to.

Example: 8575
Body
contractIdstringRequired

The unique identifier of the pending contract to decline.

Example: P-25070000
reasonstringOptional

A human-readable explanation for why the contract proposal was declined.

Example: Incompatible Content
groupIdstringOptional

The unique identifier of the partner group to which the declined partner will be added. Provide multiple IDs as a comma-separated string if adding to more than one group.

Example: 1234
Responses
200

The contract was successfully declined.

application/json
Statusstring · enumOptional

Indicates whether the decision was successfully recorded.

Example: OKPossible values:
delete/Advertisers/{AccountSID}/Programs/{ProgramId}/Contracts
DELETE /Advertisers/{AccountSID}/Programs/{ProgramId}/Contracts HTTP/1.1
Host: api.impact.com
Content-Type: application/json
Accept: */*
Content-Length: 76

{
  "contractId": "P-25070000",
  "reason": "Incompatible Content",
  "groupId": "1234"
}
{
  "Status": "OK"
}
PreviousContractsNextModels

Last updated