PUpurplegrain
Organization Roles

Change a member's permission or answer your own invite

Changed on

Change a member's permission, or let an invitee accept or decline their own invite. The role's own user may set status alone to accepted or declined. Anything else, including permission, needs edit rights on the business. A new permission cannot be more privileged than the caller's own role; an owner may assign any.

patch/organization-roles/{id}

Request

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

Path parameters

idstring required

Id of the record

Query parameters

includestring
Example:organization

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); max 10 paths. Allowed paths: organization, 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_role"
  }
}

Changes

  • 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

  • 92c4663a1266Revision changes
    • warning

      removed the optional property from the response with the status (media type: application/json)

    • warning

      removed the optional property from the response with the status (media type: application/vnd.api+json)

    • warning

      removed the optional property // from the response with the status (media type: application/json)

    • warning

      removed the optional property // from the response with the status (media type: application/vnd.api+json)

    • warning

      removed the optional property from the response with the status (media type: application/json)

    • warning

      removed the optional property from the response with the status (media type: application/vnd.api+json)

    • info

      added the optional property // to the response with the status (media type: application/json)

    • info

      added the optional property // to the response with the status (media type: application/vnd.api+json)

    • info

      added the optional property /// to the response with the status (media type: application/json)

    • info

      added the optional property /// to the response with the status (media type: application/vnd.api+json)

    • info

      added the optional property /// to the response with the status (media type: application/json)

    • info

      added the optional property /// to the response with the status (media type: application/vnd.api+json)