Skip to main content
POST
Create Credential

Headers

x-anyreach-org
string | null

Organization ID for user PATs (pat_ prefix tokens)

Body

application/json
name
string
required
Maximum string length: 64
Pattern: ^[A-Za-z0-9][A-Za-z0-9_.-]*$
description
string | null
refresher_workflow_id
string<uuid> | null
refresh_input
Refresh Input · object
refresh_policy
ManualRefreshPolicy · object

Refreshed only when someone asks (button or API).

secrets
Secrets · object

Response

Successful Response

id
string<uuid>
required
organization_id
string
required
name
string
required
created_at
string<date-time>
required
updated_at
string<date-time>
required
description
string | null
refresher_workflow_id
string<uuid> | null
refresh_input
Refresh Input · object
refresh_policy
ManualRefreshPolicy · object

Refreshed only when someone asks (button or API).

has_value
boolean
default:false
value_keys
string[]
expires_at
string<date-time> | null
last_refresh_status
enum<string> | null
Available options:
success,
failed,
in_progress
last_refresh_at
string<date-time> | null
last_refresh_error
string | null
last_refresh_execution_id
string<uuid> | null
refresh_locked_until
string<date-time> | null
is_refreshing
boolean
default:false
temporal_schedule_id
string | null
created_by
string | null
modified_by
string | null
secrets
CredentialSecretSchema · object[]