Tags group launches in your dashboard. Each tag has a name and a color, and a launch can carry several. Your tags and each launch's tag_ids are listed with your launches.
Create a tag
/launch/tags/create-tag Creates a launch tag.
- Token
- Upgraded session token, bound to a license.
- Read-only tokens
- Refused with
403 read_only_token. - Retry
- Check before retrying Each call creates a new tag, even with the same name. Look for it in
tagsfrom List the license's launches before sending it again.
Body parameters application/json
-
namestring RequiredTag name, up to 25 characters. -
colorstring RequiredColor as#RRGGBB.
Returns 200 OK · application/json
-
okbooleantruewhen the request succeeded. -
messagestringHuman-readable outcome. -
tag_idintegerID of the new tag.
Errors
| Status | Code | When and what to do |
|---|---|---|
| 400 | bad_request | name is longer than 25 characters. Shorten name to 25 characters or fewer. |
| 400 | bad_request | color is not # followed by six hex digits. Send color as #RRGGBB, for example #7C5CFF. |
Also the common errors: 401 for a missing or expired session or a base token (license_required), 403 read_only_token and 429 when rate limited.
Web client proxima.launch.tags.createTag(name, color) src/lib/proxima/endpoints/launch/tags.ts
Update a tag
/launch/tags/update-tag Renames and recolors a launch tag.
- Token
- Upgraded session token, bound to a license.
- Read-only tokens
- Refused with
403 read_only_token. - Retry
- Safe to retry A repeat sets the same name and color again.
Body parameters application/json
-
tag_idstring RequiredTag ID, as a string. -
new_namestring RequiredNew name, up to 25 characters. -
new_colorstring RequiredNew color as#RRGGBB.
Returns 200 OK · application/json
-
okbooleantruewhen the request succeeded. -
messagestringHuman-readable outcome.
Errors
| Status | Code | When and what to do |
|---|---|---|
| 400 | bad_request | new_name is longer than 25 characters. Shorten new_name to 25 characters or fewer. |
| 400 | bad_request | new_color is not # followed by six hex digits. Send new_color as #RRGGBB, for example #22C55E. |
| 404 | not_found | No tag with this tag_id belongs to your license. Use a tag id from tags in List the license's launches. |
Also the common errors: 401 for a missing or expired session or a base token (license_required), 403 read_only_token and 429 when rate limited.
Web client proxima.launch.tags.updateTag(tagId, newName, newColor) src/lib/proxima/endpoints/launch/tags.ts
Delete a tag
/launch/tags/delete-tag Deletes a launch tag.
- Token
- Upgraded session token, bound to a license.
- Read-only tokens
- Refused with
403 read_only_token. - Retry
- Safe to retry A repeat after a successful delete answers
404withTag not found.
Body parameters application/json
-
tag_idstring RequiredTag ID, as a string.
Returns 200 OK · application/json
-
okbooleantruewhen the request succeeded. -
messagestringHuman-readable outcome.
Errors
| Status | Code | When and what to do |
|---|---|---|
| 404 | not_found | No tag with this tag_id belongs to your license, or it is already deleted. Use a tag id from tags in List the license's launches. |
Also the common errors: 401 for a missing or expired session or a base token (license_required), 403 read_only_token and 429 when rate limited.
Web client proxima.launch.tags.deleteTag(tagId) src/lib/proxima/endpoints/launch/tags.ts
Tag launches
/launch/tags/tag-launches Attaches a tag to one or more launches.
- Token
- Upgraded session token, bound to a license.
- Read-only tokens
- Refused with
403 read_only_token. - Retry
- Safe to retry Launches that already carry the tag are skipped, so a repeat answers
linked: 0.
Body parameters application/json
-
tag_idstring RequiredTag ID, as a string. -
launch_idsarray<string> RequiredPublic IDs of the launches, as strings.
Returns 200 OK · application/json
-
okbooleantruewhen the request succeeded. -
messagestringHuman-readable outcome. -
linkedintegerLaunches newly tagged. Launches that already carry the tag and IDs that do not belong to your license are skipped without an error.
Errors
| Status | Code | When and what to do |
|---|---|---|
| 400 | bad_request | launch_ids is empty. Send at least one launch ID in launch_ids. |
| 404 | not_found | No tag with this tag_id belongs to your license. Use a tag id from tags in List the license's launches. |
Also the common errors: 401 for a missing or expired session or a base token (license_required), 403 read_only_token and 429 when rate limited.
Web client proxima.launch.tags.tagLaunches(tagId, launchIds) src/lib/proxima/endpoints/launch/tags.ts
Untag launches
/launch/tags/untag-launches Removes a tag from one or more launches.
- Token
- Upgraded session token, bound to a license.
- Read-only tokens
- Refused with
403 read_only_token. - Retry
- Safe to retry A repeat finds nothing left to remove and answers
removed: 0.
Body parameters application/json
-
tag_idstring RequiredTag ID, as a string. -
launch_idsarray<string> RequiredPublic IDs of the launches, as strings.
Returns 200 OK · application/json
-
okbooleantruewhen the request succeeded. -
messagestringHuman-readable outcome. -
removedintegerLaunches the tag was removed from. Launches without the tag and IDs that do not belong to your license are skipped without an error.
Errors
| Status | Code | When and what to do |
|---|---|---|
| 400 | bad_request | launch_ids is empty. Send at least one launch ID in launch_ids. |
| 404 | not_found | No tag with this tag_id belongs to your license. Use a tag id from tags in List the license's launches. |
Also the common errors: 401 for a missing or expired session or a base token (license_required), 403 read_only_token and 429 when rate limited.
Web client proxima.launch.tags.untagLaunches(tagId, launchIds) src/lib/proxima/endpoints/launch/tags.ts