Update an app

client.RealtimeKit.Apps.UpdateAppByID(ctx, appID, params) (*AppUpdateAppByIDResponse, error)

PATCH/accounts/{account_id}/realtime/kit/apps/{app_id}

Update the name of an app in your account.

Security

API Token

The preferred authorization scheme for interacting with the Cloudflare API. Create a token.

Example:Authorization: Bearer Sn3lZJTBX6kkg7OdcBUAxOO963GEIyGQqnFTOFYY

API Email + API Key

The previous authorization scheme for interacting with the Cloudflare API, used in conjunction with a Global API key.

Example:X-Auth-Email: user@example.com

The previous authorization scheme for interacting with the Cloudflare API. When possible, use API tokens instead of Global API keys.

Example:X-Auth-Key: 144c9defac04969c7bfad8efaa8ea194

Accepted Permissions (at least one required)

Realtime AdminRealtime

ParametersExpand Collapse

appID string

formatuuid

params AppUpdateAppByIDParams

AccountID param.Field[string]

Path param: The account identifier tag.

maxLength32

Name param.Field[string]

Body param: The app name. Leading and trailing whitespace is removed, and the name must contain at least one non-whitespace character.

maxLength150

ReturnsExpand Collapse

type AppUpdateAppByIDResponse struct{…}

Data AppUpdateAppByIDResponseData

ID stringOptional

formatuuid

CfAccountTag stringOptional

CreatedAt TimeOptional

formatdate-time

IsOrgOnKV boolOptional

Name stringOptional

Success AppUpdateAppByIDResponseSuccess

Update an app

package main

import (
  "context"
  "fmt"

  "github.com/cloudflare/cloudflare-go"
  "github.com/cloudflare/cloudflare-go/option"
  "github.com/cloudflare/cloudflare-go/realtime_kit"
)

func main() {
  client := cloudflare.NewClient(
    option.WithAPIToken("Sn3lZJTBX6kkg7OdcBUAxOO963GEIyGQqnFTOFYY"),
  )
  response, err := client.RealtimeKit.Apps.UpdateAppByID(
    context.TODO(),
    "182bd5e5-6e1a-4fe4-a799-aa6d9a6ab26e",
    realtime_kit.AppUpdateAppByIDParams{
      AccountID: cloudflare.F("023e105f4ecef8ad9ca31a8372d0c353"),
      Name: cloudflare.F("name"),
    },
  )
  if err != nil {
    panic(err.Error())
  }
  fmt.Printf("%+v\n", response.Data)
}

{
  "data": {
    "id": "182bd5e5-6e1a-4fe4-a799-aa6d9a6ab26e",
    "cf_account_tag": "cf_account_tag",
    "created_at": "2019-12-27T18:11:19.117Z",
    "is_org_on_kv": true,
    "name": "name"
  },
  "success": true
}

Returns Examples

{
  "data": {
    "id": "182bd5e5-6e1a-4fe4-a799-aa6d9a6ab26e",
    "cf_account_tag": "cf_account_tag",
    "created_at": "2019-12-27T18:11:19.117Z",
    "is_org_on_kv": true,
    "name": "name"
  },
  "success": true
}