Skip to main content
PUT
/
configuration
Updates the client configuration
curl --request PUT \
  --url https://api.sandbox.goteal.co/configuration \
  --header 'Content-Type: application/json' \
  --header 'X-API-KEY: <api-key>' \
  --data '
{
  "payslip_upload_enabled": true,
  "payroll_period_months": 24,
  "client_logo": "image.png",
  "client_callback_url": "https://app.client.com/callback",
  "recurring_checks_enabled": true,
  "recurring_check_frequency": "WEEKLY",
  "recurring_check_end_date": "2019-05-17T00:00:00.000Z",
  "hmrc_enabled": true,
  "payroll_connections_enabled": true,
  "client_display_name": "Acme Corporation"
}
'
{
  "payslip_upload_enabled": true,
  "payroll_period_months": 24,
  "client_logo": "image.png",
  "client_callback_url": "https://app.client.com/callback",
  "recurring_checks_enabled": true,
  "recurring_check_frequency": "WEEKLY",
  "recurring_check_end_date": "2019-05-17T00:00:00.000Z",
  "hmrc_enabled": true,
  "payroll_connections_enabled": true,
  "client_display_name": "Acme Corporation"
}

Authorizations

​
X-API-KEY
string
header
required

Body

application/json
​
payslip_upload_enabled
boolean

Determines if payslip upload via documents is allowed as a fallback if there is not connection to payroll providers

Example:

true

​
payroll_period_months
integer<int32>

Lookback period of the payroll to search on account creation

Example:

24

Client logo asset or URL

Example:

"image.png"

​
client_callback_url
string

Callback URL for client application. This will be redirected to once the user completes their journey on Teal's platform

Example:

"https://app.client.com/callback"

​
recurring_checks_enabled
boolean

Determines if recurring checks are enabled client-wide

Example:

true

​
recurring_check_frequency
string

Frequency of the recurring check for the client. Available frequencies in production are [WEEKLY, MONTHLY]. Sandbox allows HOURLY frequency in addition.

Example:

"WEEKLY"

​
recurring_check_end_date
string<date-time>

End date of the recurring check schedule client-wide

Example:

"2019-05-17T00:00:00.000Z"

​
hmrc_enabled
boolean

Determines if HMRC provider is enabled for this client. When disabled, HMRC provider will not be available in the providers list and HMRC connection endpoints will return an error.

Example:

true

​
payroll_connections_enabled
boolean

Determines if payroll connections feature is enabled for this client. When disabled, the payroll connections endpoint will return an error.

Example:

true

​
client_display_name
string | null

Editable display name for the client. This can be customized and is separate from the internal client name.

Example:

"Acme Corporation"

Response

OK

​
payslip_upload_enabled
boolean

Determines if payslip upload via documents is allowed as a fallback if there is not connection to payroll providers

Example:

true

​
payroll_period_months
integer<int32>

Lookback period of the payroll to search on account creation

Example:

24

Client logo asset or URL

Example:

"image.png"

​
client_callback_url
string

Callback URL for client application. This will be redirected to once the user completes their journey on Teal's platform

Example:

"https://app.client.com/callback"

​
recurring_checks_enabled
boolean

Determines if recurring checks are enabled client-wide

Example:

true

​
recurring_check_frequency
string

Frequency of the recurring check for the client. Available frequencies in production are [WEEKLY, MONTHLY]. Sandbox allows HOURLY frequency in addition.

Example:

"WEEKLY"

​
recurring_check_end_date
string<date-time>

End date of the recurring check schedule client-wide

Example:

"2019-05-17T00:00:00.000Z"

​
hmrc_enabled
boolean

Determines if HMRC provider is enabled for this client. When disabled, HMRC provider will not be available in the providers list and HMRC connection endpoints will return an error.

Example:

true

​
payroll_connections_enabled
boolean

Determines if payroll connections feature is enabled for this client. When disabled, the payroll connections endpoint will return an error.

Example:

true

​
client_display_name
string | null

Editable display name for the client. This can be customized and is separate from the internal client name.

Example:

"Acme Corporation"