Skip to main content
POST
Create a new credential

Authorizations

Authorization
string
header
required

LeadConduit uses HTTP Basic Authentication with the username API and your API key as the password.

For example: API:1f1b96c9150d8050e858c043d543bb4eadae0e6f'

Body

application/json

Create a new credential

Used by integrations with external services that require authentication.

Masking: Some credential types have secret fields stripped from list, show, and delete responses, and from changelog entries read back through the API:

All other fields (name, type, package, instance_id, access_key_id, region, etc.) remain visible. For the two types above, create responses return the full credential once, and update responses return the secret once only when the request supplied a new value; a blank or omitted secret on update keeps the stored value. leadconduit-infutordata credentials always mask update responses and may return some identifier fields partially masked. Other user, token, and OAuth credentials are not masked on read.

id
string
required

The unique identifier for a credential

Pattern: ^[0-9a-fA-F]{24}$
Example:

"5fd4371e940df5a34a3888b2"

name
string
required

Friendly name for this credential

package
string
required

The name of the LeadConduit integration package to which this credential belongs

type
enum<string>
required

The credential type

Available options:
user
username
string
required

The username to use for basic authentication

Minimum string length: 1
password
string
required

The password to use for basic authentication

Minimum string length: 1

Response

201 - application/json

Created

Used by integrations with external services that require authentication.

Masking: Some credential types have secret fields stripped from list, show, and delete responses, and from changelog entries read back through the API:

All other fields (name, type, package, instance_id, access_key_id, region, etc.) remain visible. For the two types above, create responses return the full credential once, and update responses return the secret once only when the request supplied a new value; a blank or omitted secret on update keeps the stored value. leadconduit-infutordata credentials always mask update responses and may return some identifier fields partially masked. Other user, token, and OAuth credentials are not masked on read.

id
string
required

The unique identifier for a credential

Pattern: ^[0-9a-fA-F]{24}$
Example:

"5fd4371e940df5a34a3888b2"

name
string
required

Friendly name for this credential

package
string
required

The name of the LeadConduit integration package to which this credential belongs

type
enum<string>
required

The credential type

Available options:
user
username
string
required

The username to use for basic authentication

Minimum string length: 1
password
string
required

The password to use for basic authentication

Minimum string length: 1
created_at
string<date-time>
read-only
updated_at
string<date-time>
read-only