Skip to main content
Programmatic equivalent of the profile fields on the dashboard’s organization settings/ page. The page and the API write through the same service, so a value saved on one reads back on the other.

​
When to use

  • An organization has no description yet, or its description is out of date.
  • The organization has been renamed, or its country was entered wrongly.
  • A human has decided whether visitors to the organization’s hosted product pages should see its public Activity card (where its scans come from and how popular its products are).

​
Auth

X-API-Key header or OAuth token. Reading the profile needs any member of the organization (or any API key of it). Writing it needs an OWNER or MANAGER (or an API key with the MANAGER role or above): an EDITOR or read-only key gets 403.

​
Flow

{organization_id} is the organization’s id. An id the caller is not a member of is 404.
  • GET — the profile: id, name, country, description, public_activity_enabled, is_brand, is_recall_observer and metadata.
  • PUT — send only the fields you are changing; a field left out, or sent as null, keeps its value.
    • name — the organization’s name. A blank name is ignored.
    • country — an ISO 3166-1 alpha-2 code such as US. Anything else is 422.
    • description — free text; "" clears it.
    • public_activity_enabled — true or false. A human’s decision: change it only when told to.
    • is_brand, is_recall_observer and metadata are written here too, but are not part of the Settings page.
The slug, the marketplace listing and the delete-protection setting are not writable over the API.

​
Verify

  1. GET the organization again and confirm each field you sent reads back with the value you intended.
  2. Confirm no field you did not send changed from the response you read before writing.