A valid request URL is required to generate request examples{
"environment": {
"id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"kind": "live",
"default_locale": "pt-BR",
"credit_overage": "block",
"created_at": "2023-11-07T05:31:56Z"
}
}{
"error": {
"code": "forbidden",
"message": "your role does not allow this action"
}
}{
"error": {
"code": "forbidden",
"message": "your role does not allow this action"
}
}{
"error": {
"code": "forbidden",
"message": "your role does not allow this action"
}
}{
"error": {
"code": "forbidden",
"message": "your role does not allow this action"
}
}Update the environment
Requires organization:update. Everything here is per environment, so a setting can be rehearsed in test while production keeps its own.
Send only the fields you are changing; the ones you leave out keep their value.
A valid request URL is required to generate request examples{
"environment": {
"id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"kind": "live",
"default_locale": "pt-BR",
"credit_overage": "block",
"created_at": "2023-11-07T05:31:56Z"
}
}{
"error": {
"code": "forbidden",
"message": "your role does not allow this action"
}
}{
"error": {
"code": "forbidden",
"message": "your role does not allow this action"
}
}{
"error": {
"code": "forbidden",
"message": "your role does not allow this action"
}
}{
"error": {
"code": "forbidden",
"message": "your role does not allow this action"
}
}Authorizations
A staff session token, uk_st_…. Minted by sign-up, sign-in or the two-factor exchange. Only a 401 means it is spent; not_a_member (403) is about the organization named in X-Organization-Id and leaves the token good for the others.
Headers
The organization the caller is acting on — the org_… code that appears in the panel URL. It identifies; the membership JOIN is what authorizes, so a forged code reads nothing: the answer is not_a_member (403), which does not mean the session is over. Absent, the session's default organization answers, or — if that membership was revoked while the session was open — any other one the caller still holds.
Path Parameters
The environment's id.
Body
Any subset of the fields.
The language this environment writes to a contact whose own language nobody reported. Send "" to go back to the platform default — here, unlike on a contact, the empty string is a choice you can mean.
A tag this platform cannot render is refused rather than stored, because a setting that appears saved and never renders is worse than one you were told about.
pt-BR, en, What POST /v1/usage does when a customer's credit balance runs out. block is the default and refuses the spend with insufficient_credit. bill lets it through and charges the excess — and needs two more things before it means anything: the plan's credit feature must name an overage_meter_ref, and the environment's payment gateway must be connected and able to report metered usage. Any of the three missing and the spend is refused, which is the safe direction: nobody is charged for something they were not told they were buying.
block, bill Response
Updated.
Show child attributes
Show child attributes