Skip to content

Update

POST
/rest/workspaces/config/update
curl --request POST \
--url https://api.shypr.app/rest/workspaces/config/update \
--header 'Content-Type: application/json' \
--header 'X-API-KEY: <X-API-KEY>' \
--data '{ "key": "email.from.name", "value": "example" }'

Creates a WorkspaceConfigUpdateInput resource.

The new WorkspaceConfigUpdateInput resource

object
key
required
string
Allowed values: email.from.name email.from.address email.transport.name email.transport.host email.transport.port email.transport.tls email.auth.username email.auth.password finance.sequence.prefix finance.sequence.suffix finance.accountant.email carriers.select-courier.key carriers.select-courier.secret carriers.sendcloud.key carriers.sendcloud.secret carriers.sendcloud.webhook.secret payment.gateway.mollie.key payment.gateway.mollie.webhook.secret payment.transaction.fee.percentage tos.file.id workspace.portal.domain workspace.brand.color workspace.onboarding.hidden app.cron.enabled app.worker.enabled
value

WorkspaceConfigUpdateInput resource created

object
key
required
string
Allowed values: email.from.name email.from.address email.transport.name email.transport.host email.transport.port email.transport.tls email.auth.username email.auth.password finance.sequence.prefix finance.sequence.suffix finance.accountant.email carriers.select-courier.key carriers.select-courier.secret carriers.sendcloud.key carriers.sendcloud.secret carriers.sendcloud.webhook.secret payment.gateway.mollie.key payment.gateway.mollie.webhook.secret payment.transaction.fee.percentage tos.file.id workspace.portal.domain workspace.brand.color workspace.onboarding.hidden app.cron.enabled app.worker.enabled
value

Example

{
"key": "email.from.name"
}

Invalid input

A representation of common errors.

object
title

A short, human-readable summary of the problem.

string | null
detail

A human-readable explanation specific to this occurrence of the problem.

string | null
status
integer | null
default: 400
instance

A URI reference that identifies the specific occurrence of the problem. It may or may not yield further information if dereferenced.

string | null
type

A URI reference that identifies the problem type

string

Example

{
"status": 400
}

Forbidden

A representation of common errors.

object
title

A short, human-readable summary of the problem.

string | null
detail

A human-readable explanation specific to this occurrence of the problem.

string | null
status
integer | null
default: 400
instance

A URI reference that identifies the specific occurrence of the problem. It may or may not yield further information if dereferenced.

string | null
type

A URI reference that identifies the problem type

string

Example

{
"status": 400
}

An error occurred

Unprocessable entity

object
status
integer
default: 422
violations
Array<object>
object
propertyPath
required

The property path of the violation

string
message
required

The message associated with the violation

string
code

The code of the violation

string
hint

An extra hint to understand the violation

string
payload

The serialized payload of the violation

object
key
additional properties
any
detail
string
type
string
title
string | null
instance
string | null

Example

{
"status": 422
}