Update an environment

PATCH

Updates a single environment, to change the name for example

environmentIdstringRequired

ID of the environment to update

X-Disable-Hooks"true"RequiredDefaults to true

This endpoint expects an object.

namestringOptional

The name of the environment

isProdbooleanOptional

Whether or not the environment is a production environment

guestAuthenticationlist of "shared_link" or "magic_link"Optional

Allowed values: shared_linkmagic_link

metadatamap from strings to anyOptional

translationsPathstringOptional

namespaceslist of stringsOptional

languageOverridestringOptional

This endpoint returns an object.

idstring

Environment ID

accountIdstring

Account ID

namestring

The name of the environment

isProdboolean

Whether or not the environment is a production environment

guestAuthenticationlist of "shared_link" or "magic_link"

Allowed values: shared_linkmagic_link

featuresmap from strings to any

metadatamap from strings to any

translationsPathstringOptional

namespaceslist of stringsOptional

languageOverridestringOptional

1	curl -X PATCH https://api.x.flatfile.com/v1/environments/us_env_YOUR_ID \
2	-H "X-Disable-Hooks: true" \
3	-H "Authorization: Bearer <token>" \
4	-H "Content-Type: application/json" \
5	-d '{
6	"name": "dev",
7	"isProd": false,
8	"guestAuthentication": [
9	"magic_link"
10	],
11	"metadata": {
12	"key": "value"
13	},
14	"namespaces": [
15	"default"
16	]
17	}'