Skip to main content
PATCH
/
channels
/
{id}
Ruby
Helo.configure do |config|
  config.access_token = "YOUR_BEARER_TOKEN"
end

id = "550e8400-e29b-41d4-a716-446655440000"
update_channel_request = Helo::UpdateChannelRequest.new(
  name: "test-name",
  delivery_type: Helo::DeliveryType::LIVE,
  tracking: Helo::UpdateChannelTracking.new(links: true, opens: true)
)
Helo::Channels.update(id, update_channel_request)
{
  "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "name": "<string>",
  "createdAt": "2023-11-07T05:31:56Z",
  "updatedAt": "2023-11-07T05:31:56Z",
  "tracking": {
    "links": true,
    "opens": true
  }
}

Authorizations

Authorization
string
header
required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Path Parameters

id
string<uuid>
required

Body

application/json
name
string
deliveryType
enum<string>
Available options:
live,
sandbox
tracking
object

Response

OK

id
string<uuid>
name
string
deliveryType
enum<string>
Available options:
live,
sandbox
createdAt
string<date-time>
updatedAt
string<date-time>
tracking
object