Replace the company profile
const url = 'https://api-staging.fedwright.com/v1/orgs/019aa3f2-6d10-7b20-9c4f-7e2d3cad5b12/profile';const options = { method: 'PUT', headers: { 'If-Match': 'example', Authorization: 'Bearer <token>', 'Content-Type': 'application/json' }, body: '{"capabilities":{"text":"Machined and fabricated airframe structural components and spares for rotary-wing aircraft, including FMS requirements."},"certifications":[{"id":"small_business","naics":["336413"]},{"id":"sdvosb","naics":[]}],"exclusions":{"departments":[],"keywords":["janitorial"]},"identity":{"cage":null,"dbas":["Example Aero"],"legalName":"Example Aero Parts LLC","uei":null},"naics":["336413","3364"],"places":{"anywhere":false,"countries":["USA"],"states":["PA","GA"]},"psc":["15","1560"]}'};
try { const response = await fetch(url, options); const data = await response.json(); console.log(data);} catch (error) { console.error(error);}curl --request PUT \ --url https://api-staging.fedwright.com/v1/orgs/019aa3f2-6d10-7b20-9c4f-7e2d3cad5b12/profile \ --header 'Authorization: Bearer <token>' \ --header 'Content-Type: application/json' \ --header 'If-Match: example' \ --data '{ "capabilities": { "text": "Machined and fabricated airframe structural components and spares for rotary-wing aircraft, including FMS requirements." }, "certifications": [ { "id": "small_business", "naics": [ "336413" ] }, { "id": "sdvosb", "naics": [] } ], "exclusions": { "departments": [], "keywords": [ "janitorial" ] }, "identity": { "cage": null, "dbas": [ "Example Aero" ], "legalName": "Example Aero Parts LLC", "uei": null }, "naics": [ "336413", "3364" ], "places": { "anywhere": false, "countries": [ "USA" ], "states": [ "PA", "GA" ] }, "psc": [ "15", "1560" ] }'NAICS and PSC codes are checked against the master lists, not against
notices, so codes that no notice uses yet are accepted. Unknown
codes return 422. The response adds the derived set-aside
eligibility.
Authorizations
Section titled “Authorizations”Parameters
Section titled “Parameters”Path Parameters
Section titled “Path Parameters”A UUIDv7.
The organization. The caller must be a member; otherwise the response is 404, as if it didn’t exist.
Header Parameters
Section titled “Header Parameters”The ETag the client last read. A stale value returns 412.
Request Bodyrequired
Section titled “Request Bodyrequired”The request body. Unknown properties are rejected.
object
What the company does.
object
Free text, used for semantic matching.
The company’s certifications.
A certification the company holds. For small_business, it also lists the NAICS codes the company is small for.
object
Supported certification IDs.
For small_business, the NAICS codes the company is small for (its size standards). Empty for the others.
What to leave out of the company’s matches.
object
Department keys.
Words or phrases. A record that has one as whole words in its title or description is left out of the company’s matches.
Used to recognize the organization as an awardee.
object
The company’s CAGE code, or null.
The names the company does business as.
The company’s legal name, or null.
The company’s UEI, or null.
Enrichment label IDs for work the company does.
The NAICS codes of the company’s work, each at any level of the hierarchy, from 2 to 6 digits or a range sector such as 31-33.
Where the company works.
object
True when place does not matter to the company.
The countries the company works in, by their ISO 3166-1 alpha-3 codes.
The US states and territories the company works in, by their two-letter codes.
The PSC codes of the company’s work, each at any level of the hierarchy.
Responses
Section titled “Responses”The profile, as stored.
The profile, with the fields Fedwright derives from it.
object
What the company does.
object
Free text, used for semantic matching.
The company’s certifications.
A certification the company holds. For small_business, it also lists the NAICS codes the company is small for.
object
Supported certification IDs.
For small_business, the NAICS codes the company is small for (its size standards). Empty for the others.
What to leave out of the company’s matches.
object
Department keys.
Words or phrases. A record that has one as whole words in its title or description is left out of the company’s matches.
Used to recognize the organization as an awardee.
object
The company’s CAGE code, or null.
The names the company does business as.
The company’s legal name, or null.
The company’s UEI, or null.
Enrichment label IDs for work the company does.
The NAICS codes of the company’s work, each at any level of the hierarchy, from 2 to 6 digits or a range sector such as 31-33.
Where the company works.
object
True when place does not matter to the company.
The countries the company works in, by their ISO 3166-1 alpha-3 codes.
The US states and territories the company works in, by their two-letter codes.
The PSC codes of the company’s work, each at any level of the hierarchy.
The profile’s codes that the latest reference refresh retired or no longer knows, so the owner can choose replacements.
A code that the latest reference refresh retired, or no longer knows, so its owner can choose a replacement.
object
The code.
What the code is: a NAICS code, a PSC code, or a set-aside code the profile is eligible for.
retired for a retired code or one from an older edition, or unknown for a code the current reference data does not have.
Set-aside codes the certifications make the company eligible for. Notices with no set-aside are always eligible.
A UUIDv7.
When the profile was last saved, or null for a profile never saved.
The number of times the profile has been saved. 0 for a profile never saved.
Examples
A company profile
{ "capabilities": { "text": "Machined and fabricated airframe structural components and spares for rotary-wing aircraft, including FMS requirements." }, "certifications": [ { "id": "small_business", "naics": [ "336413" ] }, { "id": "sdvosb", "naics": [] } ], "codeWarnings": [], "eligibleSetAsideCodes": [ "ESB", "SBA", "SBP", "SDVOSBC", "SDVOSBS", "VSA", "VSS" ], "exclusions": { "departments": [], "keywords": [ "janitorial" ] }, "identity": { "cage": null, "dbas": [ "Example Aero" ], "legalName": "Example Aero Parts LLC", "uei": null }, "naics": [ "336413", "3364" ], "orgId": "0199f0e1-2a3b-7c4d-8e5f-6a7b8c9d0e1f", "places": { "anywhere": false, "countries": [ "USA" ], "states": [ "PA", "GA" ] }, "psc": [ "15", "1560" ], "updatedAt": "2026-10-02T18:44:31Z", "version": 3}Headers
Section titled “Headers”Strong entity tag of the returned resource.
The request is malformed, or its schema refuses it: an unknown
property, a value of the wrong type or outside its bounds, a limit
above 200, or a sort outside the operation’s allow-list (Problem
type bad-request). errors names each field by its path, such as
nested.note, or $ for the body itself. The request is refused
before anything is read or written. A cursor that was altered, has
expired, or was issued for other filters, another sort, organization,
or user returns Problem type invalid-cursor.
RFC 9457 Problem Details.
object
An explanation specific to this occurrence of the problem. It is absent for server errors.
Validation errors, by field path.
object
A URI reference that identifies this occurrence of the problem, when the API provides one.
On rate-limited, the quota that is used up, such as org-day. On premium-quota-exceeded, org-premium-day. A 429 with an empty body does not name it.
On rate-limited from the API and on premium-quota-exceeded, when that quota starts again.
The HTTP status code of the response, from 400 to 599.
A short, human-readable summary of the problem. Use type to identify the kind of problem, not this text.
W3C trace ID of the failed request.
https://fedwright.com/problems/{code}, the same in every environment.
Example generated
{ "detail": "example", "errors": { "additionalProperty": [ "example" ] }, "instance": "example", "limit": "example", "resetsAt": "2026-04-15T12:00:00Z", "status": 1, "title": "example", "traceId": "example", "type": "https://example.com"}The access token is missing, expired, or invalid.
RFC 9457 Problem Details.
object
An explanation specific to this occurrence of the problem. It is absent for server errors.
Validation errors, by field path.
object
A URI reference that identifies this occurrence of the problem, when the API provides one.
On rate-limited, the quota that is used up, such as org-day. On premium-quota-exceeded, org-premium-day. A 429 with an empty body does not name it.
On rate-limited from the API and on premium-quota-exceeded, when that quota starts again.
The HTTP status code of the response, from 400 to 599.
A short, human-readable summary of the problem. Use type to identify the kind of problem, not this text.
W3C trace ID of the failed request.
https://fedwright.com/problems/{code}, the same in every environment.
Example generated
{ "detail": "example", "errors": { "additionalProperty": [ "example" ] }, "instance": "example", "limit": "example", "resetsAt": "2026-04-15T12:00:00Z", "status": 1, "title": "example", "traceId": "example", "type": "https://example.com"}The Problem type says which check refused the caller, when that is
about the caller’s own token, client, or role:
insufficient-scope when the token’s scopes (or an MCP grant’s) lack
the operation’s scope, with WWW-Authenticate: Bearer error="insufficient_scope", scope="..." (RFC 6750) naming the missing
scopes; client-not-allowed when the operation doesn’t admit the
caller’s kind of client, such as a machine client calling a user-only
operation; and insufficient-role when a confirmed member’s roles
don’t allow the action. Any other refusal is the generic forbidden,
which says nothing more. Another organization’s resource is 404
(not-found) instead, so no reason confirms that it exists. An owner
or administrator who sent no proof of a second factor gets
mfa-required. An operation
that needs an active subscription, when the organization has none,
returns subscription-inactive, or organization-suspended when
Fedwright suspended the organization. A suspended
organization also refuses invitations, new joins through an
invitation, and role changes with organization-suspended. Creating
or joining
an organization without a verified email returns email-unverified,
and accepting an invitation sent to another address returns
invitation-email-mismatch. A request from Fedwright’s web or mobile
app whose session acts for no organization yet returns
organization-required, except on getMe, createOrganization, and
acceptInvitation. Shared data needs the acting organization’s own
subscription; another organization’s doesn’t count.
RFC 9457 Problem Details.
object
An explanation specific to this occurrence of the problem. It is absent for server errors.
Validation errors, by field path.
object
A URI reference that identifies this occurrence of the problem, when the API provides one.
On rate-limited, the quota that is used up, such as org-day. On premium-quota-exceeded, org-premium-day. A 429 with an empty body does not name it.
On rate-limited from the API and on premium-quota-exceeded, when that quota starts again.
The HTTP status code of the response, from 400 to 599.
A short, human-readable summary of the problem. Use type to identify the kind of problem, not this text.
W3C trace ID of the failed request.
https://fedwright.com/problems/{code}, the same in every environment.
Example generated
{ "detail": "example", "errors": { "additionalProperty": [ "example" ] }, "instance": "example", "limit": "example", "resetsAt": "2026-04-15T12:00:00Z", "status": 1, "title": "example", "traceId": "example", "type": "https://example.com"}The resource does not exist, or belongs to another organization.
RFC 9457 Problem Details.
object
An explanation specific to this occurrence of the problem. It is absent for server errors.
Validation errors, by field path.
object
A URI reference that identifies this occurrence of the problem, when the API provides one.
On rate-limited, the quota that is used up, such as org-day. On premium-quota-exceeded, org-premium-day. A 429 with an empty body does not name it.
On rate-limited from the API and on premium-quota-exceeded, when that quota starts again.
The HTTP status code of the response, from 400 to 599.
A short, human-readable summary of the problem. Use type to identify the kind of problem, not this text.
W3C trace ID of the failed request.
https://fedwright.com/problems/{code}, the same in every environment.
Example generated
{ "detail": "example", "errors": { "additionalProperty": [ "example" ] }, "instance": "example", "limit": "example", "resetsAt": "2026-04-15T12:00:00Z", "status": 1, "title": "example", "traceId": "example", "type": "https://example.com"}The If-Match value is stale. Read the resource again and retry.
RFC 9457 Problem Details.
object
An explanation specific to this occurrence of the problem. It is absent for server errors.
Validation errors, by field path.
object
A URI reference that identifies this occurrence of the problem, when the API provides one.
On rate-limited, the quota that is used up, such as org-day. On premium-quota-exceeded, org-premium-day. A 429 with an empty body does not name it.
On rate-limited from the API and on premium-quota-exceeded, when that quota starts again.
The HTTP status code of the response, from 400 to 599.
A short, human-readable summary of the problem. Use type to identify the kind of problem, not this text.
W3C trace ID of the failed request.
https://fedwright.com/problems/{code}, the same in every environment.
Example generated
{ "detail": "example", "errors": { "additionalProperty": [ "example" ] }, "instance": "example", "limit": "example", "resetsAt": "2026-04-15T12:00:00Z", "status": 1, "title": "example", "traceId": "example", "type": "https://example.com"}The request is well formed and its schema accepts it, but it breaks a
rule beyond the schema, such as an unknown NAICS code (Problem type
validation-failed, with errors by field path). An
Idempotency-Key already used for another request returns
idempotency-key-reused.
RFC 9457 Problem Details.
object
An explanation specific to this occurrence of the problem. It is absent for server errors.
Validation errors, by field path.
object
A URI reference that identifies this occurrence of the problem, when the API provides one.
On rate-limited, the quota that is used up, such as org-day. On premium-quota-exceeded, org-premium-day. A 429 with an empty body does not name it.
On rate-limited from the API and on premium-quota-exceeded, when that quota starts again.
The HTTP status code of the response, from 400 to 599.
A short, human-readable summary of the problem. Use type to identify the kind of problem, not this text.
W3C trace ID of the failed request.
https://fedwright.com/problems/{code}, the same in every environment.
Example generated
{ "detail": "example", "errors": { "additionalProperty": [ "example" ] }, "instance": "example", "limit": "example", "resetsAt": "2026-04-15T12:00:00Z", "status": 1, "title": "example", "traceId": "example", "type": "https://example.com"}A rate limit is used up. Direct API access counts against the
organization’s burst, daily, and monthly quotas, which all its machine
clients share; there is no client quota. A 429 comes in two shapes
with two header families, so read the response by what it carries.
A machine client’s calls can get a 429 with an empty body. It
has three headers: X-RateLimit-Limit, the
exhausted rule’s limit and window, such as 3000, 3000;w=2592000;
X-RateLimit-Remaining, what is left in that window (0 on a 429);
and X-RateLimit-Reset, the seconds until that window resets. It has
no Retry-After, no RateLimit headers, no Problem, and does not
name the quota. Read the quota from the window w:
w (seconds) |
Quota |
|---|---|
| 60 | Burst. |
| 86400 | Daily. |
| 2592000 | Monthly (the calendar month is reported as 30 days; X-RateLimit-Reset is exact). |
Wait X-RateLimit-Reset seconds before you retry. Refused requests
still count: a client that keeps calling after a 429 keeps adding to
the counter, so it does not regain budget inside the window. A tier
change takes effect within 10 minutes (checkout, the billing portal,
and grants alike), once the client gets a new access token.
Every other 429 has a Problem and Retry-After. The Problem type
is rate-limited for a used-up quota, or, for an ask, ai-budget-exceeded
or premium-quota-exceeded (below). On rate-limited, Retry-After is
the seconds until the used-up limit’s window resets, the latest if
several are. The Problem also carries limit, the quota that is used
up (the one that resets last, if several are), resetsAt, when it
starts again, and traceId. RateLimit-Policy and RateLimit describe only the
caller’s own limits, here and on every other response a limit applies
to. A request refused with rate-limited uses no quota. One
refused after that check, for its scope, role, subscription, or kind of
client, still counts, so once a quota is used up such a request gets
429 instead of its 403. A request that fails authentication is
not counted. An ask that the organization’s
AI spending budget can’t cover returns ai-budget-exceeded instead,
with Retry-After at the end of the budget’s window: that budget
counts what asks cost, not how many there are. An ask that the
organization’s premium units for the day can’t cover returns
premium-quota-exceeded, with limit (org-premium-day), resetsAt
(the next midnight UTC), and Retry-After. That is the plan’s
allowance: a plan with no premium units never covers an ask, and a
higher plan may. A refused ask uses no units.
RFC 9457 Problem Details.
object
An explanation specific to this occurrence of the problem. It is absent for server errors.
Validation errors, by field path.
object
A URI reference that identifies this occurrence of the problem, when the API provides one.
On rate-limited, the quota that is used up, such as org-day. On premium-quota-exceeded, org-premium-day. A 429 with an empty body does not name it.
On rate-limited from the API and on premium-quota-exceeded, when that quota starts again.
The HTTP status code of the response, from 400 to 599.
A short, human-readable summary of the problem. Use type to identify the kind of problem, not this text.
W3C trace ID of the failed request.
https://fedwright.com/problems/{code}, the same in every environment.
Examples
An ask the premium units can't cover
{ "limit": "org-premium-day", "resetsAt": "2026-11-08T00:00:00Z", "status": 429, "title": "Too Many Requests", "traceId": "4bf92f3577b34da6a3ce929d0e0e4736", "type": "https://fedwright.com/problems/premium-quota-exceeded"}A quota used up
{ "limit": "org-day", "resetsAt": "2026-11-08T00:00:00Z", "status": 429, "title": "Too Many Requests", "traceId": "4bf92f3577b34da6a3ce929d0e0e4736", "type": "https://fedwright.com/problems/rate-limited"}Headers
Section titled “Headers”For each limit in RateLimit-Policy, the requests r its window still
allows and the seconds t until the window resets, such as
"org-burst";r=7;t=40, "org-day";r=62;t=41000.
The caller’s rate limits, in the IETF HTTPAPI RateLimit header fields:
each limit’s name, its quota q, and its window w in seconds, such as
"org-burst";q=20;w=60, "org-day";q=100;w=86400.
Seconds to wait before retrying.
On a 429 with an empty body (and on the successful responses that carry
these headers), the exhausted rule’s limit and window w in seconds,
such as 3000, 3000;w=2592000. The window names the quota: 60 is burst,
86400 is daily, and 2592000 is monthly.
What is left in that rule’s window (0 on a 429).
Seconds until that rule’s window resets.
default
Section titled “default”Any other error. A request body over 64 KiB returns 413
(payload-too-large), and a request that takes longer than 10 seconds
(90 for askOpportunities) returns 503 (request-timeout). An invitation when the API can’t send mail returns 503
(mail-unavailable), and creates nothing. An unexpected failure returns 500 (internal-error)
with only type, title, status, and traceId.
RFC 9457 Problem Details.
object
An explanation specific to this occurrence of the problem. It is absent for server errors.
Validation errors, by field path.
object
A URI reference that identifies this occurrence of the problem, when the API provides one.
On rate-limited, the quota that is used up, such as org-day. On premium-quota-exceeded, org-premium-day. A 429 with an empty body does not name it.
On rate-limited from the API and on premium-quota-exceeded, when that quota starts again.
The HTTP status code of the response, from 400 to 599.
A short, human-readable summary of the problem. Use type to identify the kind of problem, not this text.
W3C trace ID of the failed request.
https://fedwright.com/problems/{code}, the same in every environment.
Example generated
{ "detail": "example", "errors": { "additionalProperty": [ "example" ] }, "instance": "example", "limit": "example", "resetsAt": "2026-04-15T12:00:00Z", "status": 1, "title": "example", "traceId": "example", "type": "https://example.com"}