Store channel credentials
POST /api/channels/{channelId}/credentials
POST
/api/channels/{channelId}/credentials
Store or replace the credentials used by a channel to authenticate with external services. Credentials are written to a secure vault and never returned in subsequent API responses.
Authorizations
Section titled “Authorizations ”Parameters
Section titled “ Parameters ”Path Parameters
Section titled “Path Parameters ” channelId
required
string format: uuid
The unique identifier of the channel.
Request Body
Section titled “Request Body ”A flat object of string key-value pairs. The exact keys depend on the channel type.
object
key
additional properties
string
Responses
Section titled “ Responses ”The credentials were stored.
Response after storing channel credentials.
object
ok
required
Always true on success.
boolean
Example
true credentialsRef
required
The Infisical path where the credentials are stored. Used internally by the platform.
string
Example
channels/a1b2c3d4-e5f6-7890-abcd-ef1234567890/d4e5f6a7-b8c9-0123-4567-890abcdef012No channel exists with the given ID in the authenticated tenant.
Standard error response returned by all endpoints on failure.
object
error
required
A human-readable error message describing what went wrong.
string
Example
Conversation not found