Skip to main content
Updates a Trigger
curl --request PATCH \
  --url https://api.example.com/api/v4/triggers/{id} \
  --header ':cookie: <api-key>' \
  --header 'Content-Type: application/json' \
  --header 'X-Vero-Project-Id: <x-vero-project-id>' \
  --data '
{
  "object": "trigger",
  "type": "schedule",
  "id": "trigger_123",
  "campaign": "campaign_123",
  "schedule": {
    "scheduled_at": "2023-01-01T10:00+10:00",
    "batches": {
      "count": 2,
      "delay_in_minutes": 60
    },
    "object": "schedule"
  },
  "immediate": {
    "batches": {
      "count": 2,
      "delay_in_minutes": 60
    },
    "object": "immediate"
  },
  "recurring": {
    "schedule": "* 12 2 * *",
    "batches": {
      "count": 2,
      "delay_in_minutes": 60
    }
  },
  "event": {
    "transactional": true,
    "event_name": "<string>",
    "object": "event",
    "state": "draft"
  }
}
'
{
  "object": "trigger",
  "type": "schedule",
  "id": "trigger_123",
  "created_at": "2023-01-01T10:00+00:00",
  "updated_at": "2023-01-01T10:00+00:00",
  "campaign": "campaign_123",
  "schedule": {
    "scheduled_at": "2023-01-01T10:00+10:00",
    "batches": {
      "count": 2,
      "delay_in_minutes": 60
    },
    "object": "schedule"
  },
  "immediate": {
    "batches": {
      "count": 2,
      "delay_in_minutes": 60
    },
    "object": "immediate"
  },
  "recurring": {
    "schedule": "* 12 2 * *",
    "batches": {
      "count": 2,
      "delay_in_minutes": 60
    },
    "next_scheduled_at": "2023-01-01T10:00+10:00"
  },
  "event": {
    "transactional": true,
    "event_name": "<string>",
    "object": "event",
    "state": "draft"
  }
}

Authorizations

​
:cookie
string
header
required

Headers

​
X-Vero-Project-Id
integer
required

Path Parameters

​
id
string
required

Body

application/json
​
object
enum<string>
required

The resource in the response. Always trigger.

Available options:
trigger
​
type
enum<string>
required

One of immediate, schedule or recurring.

Available options:
schedule,
immediate,
recurring,
event
​
id
string
Example:

"trigger_123"

​
campaign
string
Example:

"campaign_123"

​
schedule
object

Used when launching a campaign to send at a specific time in the future.

​
immediate
object

Used when launching a campaign to send immediately.

​
recurring
object

Used when launching a campaign to run on a recurring schedule.

​
event
object

Used when launching a campaign to send immediately.

Response

OK

​
object
enum<string>
required

The resource in the response. Always trigger.

Available options:
trigger
​
type
enum<string>
required

One of immediate, schedule or recurring.

Available options:
schedule,
immediate,
recurring,
event
​
id
string
Example:

"trigger_123"

​
created_at
string<date-time>

ISO 8601 date-time string.

Example:

"2023-01-01T10:00+00:00"

​
updated_at
string<date-time>

ISO 8601 date-time string.

Example:

"2023-01-01T10:00+00:00"

​
campaign
string
Example:

"campaign_123"

​
schedule
object

Used when launching a campaign to send at a specific time in the future.

​
immediate
object

Used when launching a campaign to send immediately.

​
recurring
object

Used when launching a campaign to run on a recurring schedule.

​
event
object

Used when launching a campaign to send immediately.