Update Basic Info

Request to update the Basic Info section.

Request

Property	Value
Method	`PUT`
URL	`https://api.stormstreaming.com/api/request/stream/{stream_key}/basic-info`
Authentication	`x-api-key`

URL Parameters:

Parameter	Description
`{stream_key}`	The stream key of the stream you wish to modify

Request

bash

curl -X PUT "https://api.stormstreaming.com/api/request/stream/{stream_key}/basic-info" \
  -H "x-api-key: YOUR_API_KEY" \

Request Body

Field	Default	Required	Validation	Description
`name`	-	Yes	String 1-255 chars	Stream name
`description`	-	No	String 1-2000 chars	Stream description
`regionId`	-	Yes	Int (see regions table)	Region closest to stream source
`countdown`	0	No	Int 0/1	Display countdown before stream
`countdownStartDate`	-	If countdown=1	d.m.Y H:i:s	Planned publish date
`countdownTimezone`	-	If countdown=1	See Get Possible Values	Timezone for countdown

Available Regions:

regionId	Region
1	North America (East Coast)
2	North America (West Coast)
3	South America
4	Europe
5	Asia Pacific (China)
6	Asia Pacific (South Korea)
7	Asia Pacific (Japan)
8	Australia
9	Africa

Request Body

json

{
  "name": "Updated stream name",
  "description": "New description",
  "regionId": 4,
  "countdown": 1,
  "countdownStartDate": "25.01.2024 15:00:00",
  "countdownTimezone": "Europe/Warsaw"
}

Response

Parameter	Type	Description
`message`	string	Response status message

Successful Response (200)

json

{
  "message": "Stream has been updated."
}

Support Needed?

Create a free ticket and our support team will provide you necessary assistance.