businesses

Update a business

Partial update. Send only the fields you want to change; omitted fields keep their values, and a field you do send replaces the stored value in full (arrays included).

Errors

  • 404 NOT_FOUND: no business with this id in the active Space.
  • 400 VALIDATION_ERROR: the body failed validation; details.issues[] names each field.
put/api/v1/businesses/{id}

Request

  • Base URL: https://api.growomat.com
  • URL: https://api.growomat.com/api/v1/businesses/{id}
  • Auth: HTTP bearer

Path parameters

idstring required

The business id.

Headers

X-Space-Idstring

The Space to work in, for example spc_8f3aK2. Omit it to use your personal Space. List your Spaces returns the ids. A Space that does not exist returns 404 SPACE_NOT_FOUND; one you are not a member of returns 403 NOT_A_MEMBER.

Request body

categoryIdstring

The business category, an id from Get the creative vocabulary (businessCategories). Used to compare results with similar businesses.

namestring

Business name.

urlstring uri

The business's website: where its ads send people.

descriptionstring

What the business does. Used as context when Growomat writes copy for it.

status'ENABLED' | 'REMOVED'

Set to REMOVED to archive the business.

logoUrlstring uri nullable

The logo, by URL.

logoSource'auto-detected' | 'uploaded' | 'null' nullable

Where the logo came from.

Response

OK. The result is in data. List responses also carry meta with nextCursor and total.

dataunknown required

Changes

No recorded changes to this operation across all 2 revisions of this API.