curl --request PATCH \
--url https://api.sequin.io/v1/credentials/c906b4a4-0cda-4f46-bd80-255f570c195d \
--header 'Authorization: Bearer YOUR_API_TOKEN' \
--header 'Content-Type: application/json' \
--data '{
"metadata": { "custom_property": 42 }
}'
{
"id": "c906b4a4-0cda-4f46-bd80-255f570c195d",
"provider": "stripe",
"oauth_app_id": "8ff58ef0-d376-4ae8-b2e2-9f0206aa65b8",
"oauth_app": {
"name": "Arakkis - Stripe",
"id": "8ff58ef0-d376-4ae8-b2e2-9f0206aa65b8"
"client_id": "b9f074c939140210e8c231845bbe8b98",
"client_secret": "**********",
"metadata": {},
"provider": "stripe",
"created_at": "2024-02-20T02:10:52Z",
"updated_at": "2024-02-20T02:10:52Z"
},
"properties": {
"kind": "stripe_key",
"name": "TEST ACCOUNT",
"secret": "***********",
"test": true
},
// The health field is coming soon
"health": {
"status": "error",
"notes": [
"We're receiving 401s from Stripe for this token. That usually means the token is expired or revoked. We've emailed the owner of this credential to let them know."
],
"time": "2023-12-15 01:29:29"
},
"metadata": { "custom_property": 42 },
"created_at": "2023-12-15 01:29:29",
"updated_at": "2023-12-15 01:29:29"
}
Credentials
Update a credential
This endpoint updates a credential.
PATCH
/
v1
/
credentials
/
{id}
curl --request PATCH \
--url https://api.sequin.io/v1/credentials/c906b4a4-0cda-4f46-bd80-255f570c195d \
--header 'Authorization: Bearer YOUR_API_TOKEN' \
--header 'Content-Type: application/json' \
--data '{
"metadata": { "custom_property": 42 }
}'
{
"id": "c906b4a4-0cda-4f46-bd80-255f570c195d",
"provider": "stripe",
"oauth_app_id": "8ff58ef0-d376-4ae8-b2e2-9f0206aa65b8",
"oauth_app": {
"name": "Arakkis - Stripe",
"id": "8ff58ef0-d376-4ae8-b2e2-9f0206aa65b8"
"client_id": "b9f074c939140210e8c231845bbe8b98",
"client_secret": "**********",
"metadata": {},
"provider": "stripe",
"created_at": "2024-02-20T02:10:52Z",
"updated_at": "2024-02-20T02:10:52Z"
},
"properties": {
"kind": "stripe_key",
"name": "TEST ACCOUNT",
"secret": "***********",
"test": true
},
// The health field is coming soon
"health": {
"status": "error",
"notes": [
"We're receiving 401s from Stripe for this token. That usually means the token is expired or revoked. We've emailed the owner of this credential to let them know."
],
"time": "2023-12-15 01:29:29"
},
"metadata": { "custom_property": 42 },
"created_at": "2023-12-15 01:29:29",
"updated_at": "2023-12-15 01:29:29"
}
Request parameters
Metadata for the credential. This is a free-form object that you can use to store any additional information you want to associate with the credential.
curl --request PATCH \
--url https://api.sequin.io/v1/credentials/c906b4a4-0cda-4f46-bd80-255f570c195d \
--header 'Authorization: Bearer YOUR_API_TOKEN' \
--header 'Content-Type: application/json' \
--data '{
"metadata": { "custom_property": 42 }
}'
Response fields
{
"id": "c906b4a4-0cda-4f46-bd80-255f570c195d",
"provider": "stripe",
"oauth_app_id": "8ff58ef0-d376-4ae8-b2e2-9f0206aa65b8",
"oauth_app": {
"name": "Arakkis - Stripe",
"id": "8ff58ef0-d376-4ae8-b2e2-9f0206aa65b8"
"client_id": "b9f074c939140210e8c231845bbe8b98",
"client_secret": "**********",
"metadata": {},
"provider": "stripe",
"created_at": "2024-02-20T02:10:52Z",
"updated_at": "2024-02-20T02:10:52Z"
},
"properties": {
"kind": "stripe_key",
"name": "TEST ACCOUNT",
"secret": "***********",
"test": true
},
// The health field is coming soon
"health": {
"status": "error",
"notes": [
"We're receiving 401s from Stripe for this token. That usually means the token is expired or revoked. We've emailed the owner of this credential to let them know."
],
"time": "2023-12-15 01:29:29"
},
"metadata": { "custom_property": 42 },
"created_at": "2023-12-15 01:29:29",
"updated_at": "2023-12-15 01:29:29"
}
Provider of the credential (e.g.
github, stripe, etc). See the list of possible values.Kind of credential (e.g.
stripe_oauth, github, etc). See the list of possible values.Status of the credential. Learn more about the health object.
OAuth app associated to the credential. Learn more about the OAuth app object.
The properties for the credential. This field is polymorphic based on the credential kind. Learn more about credential properties.
Metadata for the credential. This is a free-form object that you can use to store any additional information you want to associate with the credential.