Update an industry revenue formula

put

https://api.ocrolus.com/v2/analytics/industry-revenue-formulas/{uuid}

This API updates an existing industry revenue formula. Send any subset of name, naics_codes, deduction_tags, and enabled. Omitted fields are left unchanged. The same validation rules as the Create industry revenue formula API apply to any field you send.

This feature is also available in the Ocrolus Dashboard. To learn more, see the Industry revenue formulas guide.

📘
Manager role required
This operation requires the manager role on your Ocrolus user account.

🚀
Early access
Industry-aware revenue formulas are currently available as an early access feature. To enable this feature for your organization, contact your Ocrolus account manager.

Recent Requests

Time	Status	User Agent
Retrieving recent requests…

Loading…

Path Params

uuid

string

required

The unique identifier of the industry revenue formula to update.

Body Params

Example of body to be sent to update an industry revenue formula.

name

string

Formula name. Must be unique within your organization.

naics_codes

array of strings

A list of 2-digit or 4-digit industry codes that this formula applies to. Each code must be unique across all formulas in your organization, no two formulas can share or partially share a code. A 2-digit code and a 4-digit code partially share when the 4-digit code begins with the 2-digit code. For example, 62 and 6211 clash because 6211 starts with 62.

naics_codes

deduction_tags

array of strings

Valid organization deduction tags. The reserved tags revenue and revenue_deduction are not permitted. If your organization has custom tags, you can type them in directly in addition to the values listed above.

deduction_tags

enabled

boolean

Whether the formula is applied immediately upon creation.

Responses

Language

Credentials

OAuth2

Loading…

Response

Choose an example:

application/json

200Success. Returns the full updated formula object.

400The path uuid is malformed, or the body failed validation.

401Missing or invalid bearer token.

403Authenticated, but the user doesn't have the manager role.

404No formula with that uuid exists in your organization.

409The name you sent is already used by another formula in your organization.

500Internal server error.