triggers.updateTrigger

PATCH

/v1/triggers/{triggerId}

curl --request PATCH \
  --url https://example.com/v1/triggers/example \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '{ "expected": 1, "bot": "example", "prompt": "example", "schedule": { "cron": "example", "timeZone": "example" }, "enabled": true }'

Changes a trigger and clears needsAuthorization. The caller becomes its actor, so the new tasks work for the caller.

Authorizations

• token
• session

Parameters

Path Parameters

triggerId

required

string

>= 1 characters <= 128 characters

Request Body^required

Media typeapplication/json

object

expected

required

integer

<= 9007199254740991

bot

string

>= 1 characters <= 128 characters

prompt

string

>= 1 characters <= 20000 characters

schedule

Any of:

object

object

cron

required

string

>= 1 characters <= 200 characters

timeZone

string

<= 100 characters

null

null

enabled

boolean

Example ^generated

{
  "expected": 1,
  "bot": "example",
  "prompt": "example",
  "schedule": {
    "cron": "example",
    "timeZone": "example"
  },
  "enabled": true
}

Responses

200

Success

Media typeapplication/json

object

id

required

string

>= 1 characters <= 128 characters

owner

required

Any of:

object

object

_tag

required

string

Allowed values: Member

userId

required

string

object

object

_tag

required

string

Allowed values: Organization

bot

required

string

>= 1 characters <= 128 characters

prompt

required

string

schedule

required

Any of:

object

object

cron

required

string

>= 1 characters <= 200 characters

timeZone

string

<= 100 characters

null

null

webhook

required

boolean

actor

required

string

enabled

required

boolean

needsAuthorization

required

boolean

nextRunAt

required

Any of:

number

number

null

null

executionId

required

Any of:

string

string

>= 1 characters <= 128 characters

null

null

lastFiredAt

required

Any of:

number

number

null

null

revision

required

integer

<= 9007199254740991

createdAt

required

number

updatedAt

required

number

Example

{
  "owner": {
    "_tag": "Member"
  }
}

400

TriggerInvalid | OrganizationRequired

Media typeapplication/json

Any of:

object

object

_tag

required

string

Allowed values: TriggerInvalid

message

required

string

object

object

_tag

required

string

Allowed values: OrganizationRequired

Example

{
  "_tag": "TriggerInvalid"
}

401

AuthenticationRequired

Media typeapplication/json

object

_tag

required

string

Allowed values: AuthenticationRequired

Example

{
  "_tag": "AuthenticationRequired"
}

403

@nmnmcc/ability/Authorizer/Forbidden | MembershipRequired | ForbiddenOrigin

Media typeapplication/json

Any of:

object

object

_tag

required

string

Allowed values: Forbidden

action

required

string

kind

required

string

field

string

reason

string

object

object

_tag

required

string

Allowed values: MembershipRequired

object

object

_tag

required

string

Allowed values: ForbiddenOrigin

Example

{
  "_tag": "Forbidden"
}

404

TriggerNotFound

Media typeapplication/json

object

_tag

required

string

Allowed values: TriggerNotFound

id

required

string

Example

{
  "_tag": "TriggerNotFound"
}

409

@nmnmcc/ability/Authorizer/Pending | TriggerConflict

Media typeapplication/json

Any of:

object

object

_tag

required

string

Allowed values: Pending

ticket

required

string

reason

string

object

object

_tag

required

string

Allowed values: TriggerConflict

message

required

string

Example

{
  "_tag": "Pending"
}

429

RateLimited

Media typeapplication/json

object

_tag

required

string

Allowed values: RateLimited

retryAfterSeconds

required

integer

>= -9007199254740991 <= 9007199254740991

Example

{
  "_tag": "RateLimited"
}

503

TriggerStorageUnavailable | AuthenticationUnavailable | RequestFailed

Media typeapplication/json

Any of:

object

object

_tag

required

string

Allowed values: PolicyUnavailable

object

object

_tag

required

string

Allowed values: TriggerStorageUnavailable

object

object

_tag

required

string

Allowed values: AuthenticationUnavailable

object

object

_tag

required

string

Allowed values: RequestFailed

category

required

string

Allowed values: invalid forbidden not_found conflict unavailable external outcome_unknown interrupted

errorId

required

string

>= 1 characters <= 128 characters

Example

{
  "_tag": "PolicyUnavailable"
}