Delete Participants

Delete participants from an event. This cannot be undone, so use with caution. By default, only imported participants can be deleted, but this can be changed by setting the allow_non_imports option. This requires that you pass in the registration ID, which can be obtained from the Get Race Participants method. A maximum of 250 participants can be deleted per request. The response is a list of the registration IDs removed.

Request Format


{
	"registrations": [
		{
			"registration_id": 123
		},
		{
			"registration_id": 456
		}
	]
}

Response Format


{
	"participants": [
		{
			"registration_id": 123
		}, {
			"registration_id": 456
		}
	]
}

URL

https://www.givesignup.org/rest/race/:race_id/delete-participants

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. format

Parameters

Parameter HTTP Method Default Description Datatype
race_id
Required
POST ID of race. uint
request_format POST xml Format of request. format
allow_non_imports POST F Should non-imported registrations be allowed to be deleted? bool
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.