Update Event Subscription

PATCH/accounts/{account_id}/event_subscriptions/subscriptions/{subscription_id}

Update an existing event subscription

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)

Queues WriteWorkers Scripts Write

Path ParametersExpand Collapse

account_id: string

A Resource identifier.

maxLength32

subscription_id: string

A Resource identifier.

maxLength32

Body ParametersJSONExpand Collapse

destination: optional object { queue_id, type }

Destination configuration for the subscription

queue_id: string

ID of the target queue

type: "queues.queue"

Type of destination

enabled: optional boolean

Whether the subscription is active

events: optional array of string

List of event types this subscription handles

name: optional string

Name of the subscription

ReturnsExpand Collapse

errors: optional array of ResponseInfo { code, message, documentation_url, source }

minLength1

code: number

minimum1000

message: string

documentation_url: optional string

source: optional object { pointer }

pointer: optional string

messages: optional array of string

result: optional object { id, created_at, destination, 5 more }

id: string

Unique identifier for the subscription

created_at: string

When the subscription was created

formatdate-time

destination: object { queue_id, type }

Destination configuration for the subscription

queue_id: string

ID of the target queue

type: "queues.queue"

Type of destination

enabled: boolean

Whether the subscription is active

events: array of string

List of event types this subscription handles

modified_at: string

When the subscription was last modified

formatdate-time

name: string

Name of the subscription

source: object { type } or object { type } or object { type } or 6 more

Source configuration for the subscription

One of the following:

MqEventSourceImages object { type }

type: optional "images"

Type of source

MqEventSourceKV object { type }

type: optional "kv"

Type of source

MqEventSourceR2 object { type }

type: optional "r2"

Type of source

MqEventSourceSuperSlurper object { type }

type: optional "superSlurper"

Type of source

MqEventSourceVectorize object { type }

type: optional "vectorize"

Type of source

MqEventSourceWorkersAIModel object { model_name, type }

model_name: optional string

Name of the Workers AI model

type: optional "workersAi.model"

Type of source

MqEventSourceWorkersBuildsWorker object { type, worker_name }

type: optional "workersBuilds.worker"

Type of source

worker_name: optional string

Name of the worker

MqEventSourceWorkersScript object { script_tag, type }

script_tag: optional string

Tag of the Worker script

type: optional "workers.script"

Type of source

MqEventSourceWorkflowsWorkflow object { type, workflow_name }

type: optional "workflows.workflow"

Type of source

workflow_name: optional string

Name of the workflow

success: optional true

Indicates if the API call was successful or not.

Update Event Subscription

curl https://api.cloudflare.com/client/v4/accounts/$ACCOUNT_ID/event_subscriptions/subscriptions/$SUBSCRIPTION_ID \
    -X PATCH \
    -H 'Content-Type: application/json' \
    -H "Authorization: Bearer $CLOUDFLARE_API_TOKEN" \
    -d '{}'

200 example

{
  "errors": [
    {
      "code": 7003,
      "message": "No route for the URI",
      "documentation_url": "documentation_url",
      "source": {
        "pointer": "pointer"
      }
    }
  ],
  "messages": [
    "string"
  ],
  "result": {
    "id": "id",
    "created_at": "2019-12-27T18:11:19.117Z",
    "destination": {
      "queue_id": "queue_id",
      "type": "queues.queue"
    },
    "enabled": true,
    "events": [
      "string"
    ],
    "modified_at": "2019-12-27T18:11:19.117Z",
    "name": "name",
    "source": {
      "type": "images"
    }
  },
  "success": true
}

Returns Examples

200 example

{
  "errors": [
    {
      "code": 7003,
      "message": "No route for the URI",
      "documentation_url": "documentation_url",
      "source": {
        "pointer": "pointer"
      }
    }
  ],
  "messages": [
    "string"
  ],
  "result": {
    "id": "id",
    "created_at": "2019-12-27T18:11:19.117Z",
    "destination": {
      "queue_id": "queue_id",
      "type": "queues.queue"
    },
    "enabled": true,
    "events": [
      "string"
    ],
    "modified_at": "2019-12-27T18:11:19.117Z",
    "name": "name",
    "source": {
      "type": "images"
    }
  },
  "success": true
}