GiveSignup: API - Create or Edit Race Teams

RunSignup API Documentation

API Overview Getting Started API Keys Documentation API Methods Error Codes Code Examples

Create or Edit Race Teams

Use this API to create or edit race teams. Teams with a team_id will be treated as an edit, otherwise a new team will be created. If you leave off fields from a team, null will be assumed. The deleted_team_ids field can be used to delete race teams as well. The request POST parameter should be JSON like shown below.

Request Format

{
	"race_teams": [
		{
			"team_id": 123,
			"team_name": "API Team 1",
			"team_type_id": 456,
			"team_age_restriction_id": null,
			"team_gender": "F",
			"team_bib_num": 1
		},
		{
			"team_name": "API Team 2",
			"team_type_id": 456,
			"team_age_restriction_id": null,
			"team_gender": "M",
			"team_bib_num": 2
		}
	],
	"deleted_team_ids": [321]
}

Field	Type	Required?	Description
`race_teams.team_id`	`int`	No	Team ID if editing.
`race_teams.team_name`	`string`	Yes	Team name.
`race_teams.team_type_id`	`int`	Yes	Team type ID.
`race_teams.team_age_restriction_id`	`int`	No	ID associated with an age range on the team type for this team.
`race_teams.team_gender`	`string`	No	Team gender. One of the following: `C` - Coed `M` - Male `F` - Female
`race_teams.team_bib_num`	`int`	No	Team bib number.
`deleted_team_ids`	`int[]`	No	Team IDs to delete.

Response Format

	"race_team_ids": [
		123,
		234
	],
	"deleted_team_ids": [
		321
	]

Field	Type	Description
`race_team_ids`	`int[]`	List of race team IDs in the request order.
`deleted_team_ids`	`int[]`	List of deleted team IDs in the request order.

URL

https://www.givesignup.org/rest/v2/teams/manage-teams.json

HTTP Method

POST

Standard Parameters

Parameter	HTTP Method	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`

Parameters

Parameter	HTTP Method	Description	Datatype
`race_id` Required	GET	Race ID.	`uint`
`event_ids` Required	GET	ID of event or list of event IDs separated by commas.	`id_list`
`request` Required	POST	JSON containing request data.	`string`