GitLab API icon

GitLab API

Gitlab
Join our community

Actions880

Overview

This node operation updates a broadcast message in GitLab by its ID using the PUT HTTP method. It is useful for scenarios where you need to modify existing broadcast messages, such as changing the message content or its display settings. For example, an administrator can update a scheduled broadcast message to reflect new information or correct errors.

Use Case Examples

  1. Updating a broadcast message's content by specifying its ID and new message details.
  2. Modifying the display duration or target audience of an existing broadcast message.

Properties

Name Meaning
Skip Authentication Option to skip authentication for the request, useful for testing or when authentication is handled externally.
Authentication Specifies the authentication method to use, defaulting to GitLab API key authentication.
baseUrl The base URL of the GitLab instance, defaulting to https://gitlab.com.
Method HTTP method to use for the request, defaulting to PUT for this operation.
Path Parameters Parameters included in the request path, specifically the 'id' of the broadcast message to update.

Output

JSON

  • id - The unique identifier of the updated broadcast message.
  • message - The content of the broadcast message.
  • starts_at - The start time when the broadcast message becomes active.
  • ends_at - The end time when the broadcast message expires.
  • color - The color associated with the broadcast message for display purposes.
  • broadcast_type - The type/category of the broadcast message.

Dependencies

  • GitLab API key credential

Troubleshooting

  • Ensure the 'id' path parameter is correctly set to the broadcast message ID you want to update; otherwise, the request will fail.
  • Verify that the authentication credentials are valid and have sufficient permissions to update broadcast messages.
  • Check that the baseUrl is correctly set to your GitLab instance URL if not using the default https://gitlab.com.
  • Common error messages include 401 Unauthorized (invalid or missing credentials), 404 Not Found (broadcast message ID does not exist), and 400 Bad Request (invalid request body or parameters).

Links

Discussion