> ## Documentation Index
> Fetch the complete documentation index at: https://developers.conveyour.com/llms.txt
> Use this file to discover all available pages before exploring further.

# Update a trigger

> Updates an existing trigger.

Update a trigger

**Permission:** Requires `automations` **or** `campaigns`; sending `type: "lesson"` additionally requires `lessons`. Denials read `Manage Automations or Campaigns`.

**A missing or invalid record returns `400`, not `404`.** Failures here go through the controller's shared error helper, which passes `400` explicitly.



## OpenAPI

````yaml /api-reference/specs/triggers.json put /api/triggers/{id}
openapi: 3.1.0
info:
  title: ConveYour API — Triggers
  description: Retrieve, create, validate, and update campaign triggers.
  version: 1.0.0
servers:
  - url: https://{subdomain}.conveyour.com
    description: Your organization's ConveYour instance
    variables:
      subdomain:
        default: acme
        description: >-
          Your organization's slug — the subdomain you sign in on. Replace
          `acme` with yours: if you sign in at `bigco.conveyour.com`, enter
          `bigco`.
security:
  - conveyourToken: []
tags:
  - name: Triggers
    description: Retrieve, create, validate, and update campaign triggers.
paths:
  /api/triggers/{id}:
    put:
      tags:
        - Triggers
      summary: Update a trigger
      description: >-
        Updates an existing trigger.


        Update a trigger


        **Permission:** Requires `automations` **or** `campaigns`; sending
        `type: "lesson"` additionally requires `lessons`. Denials read `Manage
        Automations or Campaigns`.


        **A missing or invalid record returns `400`, not `404`.** Failures here
        go through the controller's shared error helper, which passes `400`
        explicitly.
      operationId: updateATrigger
      parameters:
        - name: id
          in: path
          required: true
          description: The id identifier.
          schema:
            type: string
        - $ref: '#/components/parameters/teams'
      requestBody:
        required: false
        content:
          application/json:
            schema:
              type: object
              properties:
                campaign_id:
                  description: Campaign context (used for scoping the update lookup).
                  type: string
                draft:
                  description: >-
                    Set to `true` or `false` to change the trigger's draft
                    state.
                  type: boolean
                paused:
                  description: Set to `true` to pause the trigger, `false` to resume.
                  type: boolean
                ...:
                  description: >-
                    Any other top-level trigger fields to update (e.g.
                    `lesson_id`, `delay`, `name`).
                  type: string
      responses:
        '200':
          description: Success.
          content:
            application/json:
              schema:
                allOf:
                  - $ref: '#/components/schemas/Envelope'
                  - type: object
                    properties:
                      data:
                        $ref: '#/components/schemas/Trigger'
              example:
                status: ok
                message: success
                data:
                  id: TRIGGER_ID
                  campaign_id: CAMPAIGN_ID
                  type: lesson
                  lesson_id: NEW_LESSON_ID
                  delay: 86400
        '400':
          description: >-
            `Cannot <action>` — the record could not be found or the change was
            rejected. Carries field-level errors in `data`.
        '403':
          $ref: '#/components/responses/Forbidden'
components:
  parameters:
    teams:
      name: teams[]
      in: query
      description: >-
        Team scope for the request, as one or more team ObjectIds. The brackets
        are required: PHP keeps only the last value for a repeated plain key, so
        `teams=A&teams=B` silently resolves to B alone. On requests with a JSON
        body you may send `teams` (no brackets) in the body instead.


        **Values that are not valid ObjectIds are silently ignored** — a
        mistyped team ID behaves as if no team was sent. See the [teams section
        of the API conventions guide](/guides/api-conventions#team-scoping).
      style: form
      explode: true
      schema:
        type: array
        items:
          type: string
      example:
        - 64a1b2c3d4e5f6a7b8c9d0ff
  schemas:
    Envelope:
      type: object
      description: The common response envelope shared by all ConveYour endpoints.
      properties:
        status:
          type: string
          enum:
            - ok
            - failed
          description: '`ok` on success, `failed` on error.'
        message:
          type: string
          description: Human-readable description of the result.
        data:
          description: >-
            The response payload — an object or an array depending on the
            endpoint.
    Trigger:
      type: object
      description: >-
        An automation trigger. Each trigger type carries additional
        type-specific keys beyond the base fields listed here.
      properties:
        id:
          type: string
          description: Trigger ID.
        org_id:
          type: integer
          description: Owning organization.
        name:
          type: string
          description: Trigger name.
        notes:
          type: string
          description: Internal notes.
        type:
          type: string
          description: Trigger type, which determines the extra fields present.
        delay:
          type: number
          description: Delay before the trigger fires.
        start_date:
          type: string
          description: Start date.
        start_at:
          type: string
          description: Start time.
        tz_relative:
          type: boolean
          description: Whether timing is relative to the contact's timezone.
        automatic:
          type: boolean
          description: Whether the trigger runs automatically.
        end_days:
          type: number
          description: Days until the trigger stops.
        join_delay:
          type: boolean
          description: Whether to delay on join.
        order:
          type: number
          description: Sort order.
        bookmark:
          type: object
          description: Bookmark defining the audience.
        bookmark_id:
          type: string
          description: Audience bookmark ID.
        wf_pid:
          type: string
          description: Workflow public ID.
        wf_if:
          type: string
          description: Workflow condition.
        wf_detached:
          type: boolean
          description: Whether the workflow step is detached.
        created_at:
          type: integer
          description: Unix timestamp.
        updated_at:
          type: integer
          description: Unix timestamp.
      required:
        - name
      additionalProperties:
        description: >-
          Type-specific fields declared by the trigger type (`sms`, `email`,
          `lesson` and so on).
  responses:
    Forbidden:
      description: >-
        The token is missing or invalid, or the service account behind it lacks
        the permission this endpoint requires.
      content:
        application/json:
          example:
            status: failed
            message: Lacking necessary permission add_contacts
            data:
              permission: add_contacts
  securitySchemes:
    conveyourToken:
      type: apiKey
      in: header
      name: x-conveyour-token
      description: >-
        Your API key token. Contacts endpoints require a **Server-only — Full
        API** key — see [Authentication](/quickstart).

````

This documentation is built and hosted on [Mintlify](https://mintlify.com), a developer documentation platform.