Welcome‎ > ‎Version 3‎ > ‎Publisher Api‎ > ‎Methods‎ > ‎4 - Publisher Related‎ > ‎

Delete Pending Credits

** The Authentication of this method will change.  If you'd like to be notified of the change, please post in the comment section below so you can be notified before the change. **

Will delete pending credits from the system based on the request parameters.  Pending credits that have already been awarded will not be deleted.

Method: POST /api/v3/publisher/pendingcredits

Authentication: oauth
 
Post
Required Form Name Data Type Explanation
No
AwardTriggerType string If provided, will only delete pending credits with this award trigger type.  One of {ForNextPurchase, AfterNextPurchase, OnSignUp}.
No
CampaignKey
string If provided, will only delete pending credits with this campaign key.
No EmailAddress string If provided, will only delete pending credits with this email address.
No ExpirationDateRange Date Range
If provided, will only delete pending credits that have an expiration date within this date range.

Returns
pendingCreditsDeleted - The number of pending credits deleted from the system.
base response fields


Sample Request:

DELETE http://api.groupcommerce.com/api/v3/publisher/pendingcredits

Form: AwardTriggerType=ForNextPurchase&EmailAddress=pendingcredits%40groupcommerce.com&CampaignKey=heart-of-it-all&ExpirationDateRange=t1406088000-t935467200


OAuth oauth_signature="cpr9dEJZTHEW0pc2QxpPKg8gj3Y%3D", oauth_nonce="6815109", oauth_timestamp="1347495507", oauth_consumer_key="eeb6b959-b854-4ad1-b563-e801c83cf81d", oauth_signature_method="HMAC-SHA1", oauth_version="1


Sample JSON Response:

{
    "errors": [],
    "lastPublished": "/Date(1347495507579)/",
    "success": true,
    "version": "3",
    "pendingCreditsDeleted": 123
}


Sample XML Response:

<deletePendingCreditsResponse xmlns:i="http://www.w3.org/2001/XMLSchema-instance">
  <errors />
  <lastPublished>2012-09-13T00:19:23.0144482Z</lastPublished>
  <success>true</success>
  <version>3</version>
  <pendingCreditsDeleted>123</pendingCreditsDeleted>
</deletePendingCreditsResponse>
Comments