1. RunSignup
  2. API
  3. Methods
  4. Set Up Event Giveaway

Set Up Event Giveaway

Call this API method to set up the giveaway for an event. To edit an existing giveaway option, include the giveaway_option_id field with the giveaway option information. Any existing giveaway option not in the request will be deleted. The order that the giveaway options appear here will be the order they are displayed to users. The response includes the giveaway options ids in the order defined. If there are no giveaway options provided, giveaways will be disabled.

For JSON requests, the request should look like the example below.

{
	"giveaway": "Text of give-away shown to user.  E.g. \"T-Shirt\"",
	"giveaway_cutoff_date": "2014-12-31",
	"giveaway_options": [
		{
			"giveaway_option_id": 12345,
			"giveaway_option_text": "None",
			"additional_cost_in_cents": -200
		},
		{
			"giveaway_option_id": 12346,
			"giveaway_option_text": "Small",
			"additional_cost_in_cents": 0
		},
		{
			"giveaway_option_id": 12347,
			"giveaway_option_text": "Medium",
			"additional_cost_in_cents": 0
		},
		{
			"giveaway_option_id": 12348,
			"giveaway_option_text": "Large",
			"additional_cost_in_cents": 0
		},
		{
			"giveaway_option_id": 12349,
			"giveaway_option_text": "XLarge",
			"additional_cost_in_cents": 500
		}
	]
}

For XML requests, the request should look like the example below.

<giveaway_settings>
  <giveaway>Text of give-away shown to user.  E.g. "T-Shirt"</giveaway>
	<giveaway_cutoff_date>2014-12-31</giveaway_cutoff_date>
	<giveaway_options>
		<giveaway_option>
			<giveaway_option_id>12345</giveaway_option_id>
			<giveaway_option_text>None</giveaway_option_text>
			<additional_cost_in_cents>-200</additional_cost_in_cents>
		</giveaway_option>
		<giveaway_option>
			<giveaway_option_id>12346</giveaway_option_id>
			<giveaway_option_text>Small</giveaway_option_text>
			<additional_cost_in_cents>0</additional_cost_in_cents>
		</giveaway_option>
		<giveaway_option>
			<giveaway_option_id>12347</giveaway_option_id>
			<giveaway_option_text>Medium</giveaway_option_text>
			<additional_cost_in_cents>0</additional_cost_in_cents>
		</giveaway_option>
		<giveaway_option>
			<giveaway_option_id>12348</giveaway_option_id>
			<giveaway_option_text>Large</giveaway_option_text>
			<additional_cost_in_cents>0</additional_cost_in_cents>
		</giveaway_option>
		<giveaway_option>
			<giveaway_option_id>12349</giveaway_option_id>
			<giveaway_option_text>XLarge</giveaway_option_text>
			<additional_cost_in_cents>500</additional_cost_in_cents>
		</giveaway_option>
  </giveaway_options>
</giveaway_settings>

URL

https://www.givesignup.org/rest/race/:race_id/giveaways

HTTP Method

POST

Standard Parameters

Parameter HTTP Method Default Description Datatype
api_key GET API Key string
api_secret GET API Secret string
tmp_key GET Temporary API Key from login API call. This should NOT be used in combination with API Key. string
tmp_secret GET Temporary API Secret from login API call. This should NOT be used in combination with API Secret. string
rsu_api_key GET API v2 key. If used, you must send the API secret in an HTTP header named X-RSU-API-SECRET. string
sp_api_key GET Super partner API key. If used, you must send the API secret in an HTTP header named X-RSU-API-SECRET. string
X-RSU-API-SECRET HTTP Header API v2 or super partner secret. string
format GET xml Format of response. The default if not sent is `xml`, but `json` is preferred. format

Parameters

Parameter HTTP Method Default Description Datatype
race_id
Required
POST ID of race. uint
event_id
Required
POST ID of event. uint
request_format POST xml Format of request. The default if not sent is `xml`, but `json` is preferred. format
request
Required
POST Request in proper format. string

If you continue to use this site, you consent to use all cookies. We use cookies to offer you a better browsing experience. Read how we use cookies and how you can control them by visiting our Privacy Policy.

If you continue to use this site, you consent to use all cookies.