PUpurplegrain
Organizations

Update a business

Changed on

Updates the business's name, slug, place, contact details, or ai_format_enabled ("Allow PurpleGrain AI to read my records"). Needs edit rights on the business.

patch/organizations/{id}

Request

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

Path parameters

idstring required

Id of the record

Query parameters

includestring
Example:organization_roles.user

Comma-separated snake_case relationship paths to embed (JSON:API included array, or inlined for application/json). Never embedded by default; a path outside the allowed list is refused with 400 unknown_include (see the 400 response); dot notation selects children; max 10 paths. Allowed paths: city, city.location, place, place.location, services, organization_roles, organization_roles.user.

Request body

Response

Update. When the include query parameter is used, the response may contain an included array (JSON:API) or inlined related resources (application/json).

Example response

{
  "data": {
    "type": "organization"
  }
}

Changes

  • 370fe2f3ed4fRevision changes
    • info

      the request property / became nullable (media type: application/json)

    • info

      the request property // became nullable (media type: application/vnd.api+json)

  • 143d65e52617Revision changes
    • info

      added the non-success response with the status

    • info

      added the non-success response with the status

    • info

      added the non-success response with the status