Skip to main content
POST
workflow.credential.update

Authorizations

Authorization
string
header
required

API key: sk_live_…

Headers

Idempotency-Key
string
required

Required: this capability has an external effect.

Maximum string length: 255
Pramaan-Account
string

Optional. One of your account ids (GET /v1/accounts): run on that account, whatever your routing rules say. The response header X-Pramaan-Account names the account that ran.

Pramaan-End-User
string

Optional. Your own tag for your end user: a sticky: end_user rule keeps them on the account that first served them.

Maximum string length: 256
Pramaan-End-User-Group
string

Optional. Your end user's group, matched by rules with endUserGroup.

Maximum string length: 64

Body

application/json
credentialId
string
required

Record ID in your connected account.

Required string length: 1 - 250
Pattern: ^[A-Za-z0-9_-]+$
name
string

Display name.

Required string length: 1 - 250
typeKey
string

New write-only connector selector; requires values.

Required string length: 1 - 250
Pattern: ^[A-Za-z0-9_-]+$
values
object

JSON fields. Values are sent once and never echoed.

global
boolean

Share across the instance.

resolvable
boolean

Allow dynamically resolved fields.

mergeValues
boolean
default:false

Merge values instead of replacing them. Only valid with values. Default false.

Response

The result

credentialId
string
required

Credential ID in your connected account.

Required string length: 1 - 250
Pattern: ^[A-Za-z0-9_-]+$
name
string
required

Display name.

Required string length: 1 - 250
updated
boolean
required

Credential updated.

createdAt
string<date-time>

Time in ISO 8601 format.

Pattern: ^(?:(?:\d\d[2468][048]|\d\d[13579][26]|\d\d0[48]|[02468][048]00|[13579][26]00)-02-29|\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\d|30)|(?:02)-(?:0[1-9]|1\d|2[0-8])))T(?:(?:[01]\d|2[0-3]):[0-5]\d:[0-5]\d(?:\.\d+)?(?:Z|([+-](?:[01]\d|2[0-3]):[0-5]\d)))$
updatedAt
string<date-time>

Time in ISO 8601 format.

Pattern: ^(?:(?:\d\d[2468][048]|\d\d[13579][26]|\d\d0[48]|[02468][048]00|[13579][26]00)-02-29|\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\d|30)|(?:02)-(?:0[1-9]|1\d|2[0-8])))T(?:(?:[01]\d|2[0-3]):[0-5]\d:[0-5]\d(?:\.\d+)?(?:Z|([+-](?:[01]\d|2[0-3]):[0-5]\d)))$
global
boolean

Whether the credential is shared across the instance.

resolvable
boolean

Whether credential fields can be resolved dynamically.