Invite or add a person to a business
Create a business membership or invitation with the requested permission and status. Supply the organization relationship and identify the person through a user relationship, invited_email, or invited_mobile. Requires edit rights on the business; the assigned permission cannot exceed the caller's own role.
Inviting by email or mobile may send an email or SMS. A matching existing account is linked to the role; otherwise a pending invitation carries a seven-day link. Confirm the business, person and permission before creating the role. Returns the created membership or invitation. This does not create a user account or accept an invitation for them.
Request
- Base URL: https://api.purplegrain.com/api/v1
- URL: https://api.purplegrain.com/api/v1/organization-roles
- Auth: HTTP bearer
Query parameters
Comma-separated snake_case relationship paths to embed (JSON:API included array, or inlined for application/json). Never embedded by default; unknown paths ignored; max 10 paths. Allowed paths: organization, user.
Request body
Response
Created. 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
No recorded changes to this operation across all 2 revisions of this API.