Update Automations settings

PATCH

/api/v1/automations/settings

curl --request PATCH \
  --url https://digize.com/api/v1/automations/settings \
  --header 'Content-Type: application/json' \
  --header 'Idempotency-Key: 5f1c2a8e-3b7d-4c55-9a0e-1f2d3c4b5a69' \
  --header 'x-api-key: <x-api-key>' \
  --data '{ "timeoutMinutes": 1, "retries": 1, "saveRunData": "all", "retentionDays": 1, "errorWorkflowId": "example", "timezone": "example", "concurrency": 1, "notifyByEmail": true, "notifyEmails": [ "hello@example.com" ], "notifyBySlack": true, "slackCredentialId": "example", "slackChannel": "example" }'

• Digize

Changes some of Automations settings; the rest stay.

Needs the automations:write permission.

Authorizations

• apiKey
• bearer

Parameters

Header Parameters

Idempotency-Key

string

>= 1 characters <= 255 characters

Makes the request safe to send again: for 24 hours the same key and request answer the first response without repeating the change.

Example

5f1c2a8e-3b7d-4c55-9a0e-1f2d3c4b5a69

Request Body^required

Media typeapplication/json

object

timeoutMinutes

integer

>= 1 <= 60

retries

integer

<= 5

saveRunData

string

Allowed values: all errors none

retentionDays

integer

>= 1 <= 90

errorWorkflowId

Any of:

string

string

<= 64 characters

null

null

timezone

Any of:

string

string

<= 64 characters

null

null

concurrency

integer

>= 1 <= 50

notifyByEmail

boolean

notifyEmails

Array<string>

<= 20 items

notifyBySlack

boolean

slackCredentialId

Any of:

string

string

<= 64 characters

null

null

slackChannel

string

<= 80 characters

Responses

200

Done

Media typeapplication/json

object

timeoutMinutes

required

integer

>= 1 <= 60

retries

required

integer

<= 5

saveRunData

required

string

Allowed values: all errors none

retentionDays

required

integer

>= 1 <= 90

errorWorkflowId

required

Any of:

string

string

<= 64 characters

null

null

timezone

required

Any of:

string

string

<= 64 characters

null

null

concurrency

required

integer

>= 1 <= 50

notifyByEmail

required

boolean

notifyEmails

required

Array<string>

<= 20 items

notifyBySlack

required

boolean

slackCredentialId

required

Any of:

string

string

<= 64 characters

null

null

slackChannel

required

string

<= 80 characters

webhookBaseUrl

required

Webhook triggers listen at this address followed by their path.

string

signingSecret

required

Any of:

object

object

hint

required

string

createdAt

required

string format: date-time

null

null

Example

{
  "saveRunData": "all"
}

400

What was sent isn’t valid (invalid).

Media typeapplication/json

object

error

required

object

code

required

string

Allowed values: invalid unauthorized forbidden not_found conflict too_large rate_limited unavailable internal

message

required

string

details

object

key

additional properties

any

Example

{
  "error": {
    "code": "invalid"
  }
}

401

No key, or one that’s unknown, off or expired.

Media typeapplication/json

object

error

required

object

code

required

string

Allowed values: invalid unauthorized forbidden not_found conflict too_large rate_limited unavailable internal

message

required

string

details

object

key

additional properties

any

Example

{
  "error": {
    "code": "invalid"
  }
}

403

The key doesn’t have the permission this needs.

Media typeapplication/json

object

error

required

object

code

required

string

Allowed values: invalid unauthorized forbidden not_found conflict too_large rate_limited unavailable internal

message

required

string

details

object

key

additional properties

any

Example

{
  "error": {
    "code": "invalid"
  }
}

404

Nothing has that id (not_found).

Media typeapplication/json

object

error

required

object

code

required

string

Allowed values: invalid unauthorized forbidden not_found conflict too_large rate_limited unavailable internal

message

required

string

details

object

key

additional properties

any

Example

{
  "error": {
    "code": "invalid"
  }
}

409

A request with the same Idempotency-Key is still running (conflict).

Media typeapplication/json

object

error

required

object

code

required

string

Allowed values: invalid unauthorized forbidden not_found conflict too_large rate_limited unavailable internal

message

required

string

details

object

key

additional properties

any

Example

{
  "error": {
    "code": "invalid"
  }
}

422

The Idempotency-Key was used with a different request.

Media typeapplication/json

object

error

required

object

code

required

string

Allowed values: invalid unauthorized forbidden not_found conflict too_large rate_limited unavailable internal

message

required

string

details

object

key

additional properties

any

Example

{
  "error": {
    "code": "invalid"
  }
}

429

Over the rate limit; see retry-after.

Media typeapplication/json

object

error

required

object

code

required

string

Allowed values: invalid unauthorized forbidden not_found conflict too_large rate_limited unavailable internal

message

required

string

details

object

key

additional properties

any

Example

{
  "error": {
    "code": "invalid"
  }
}