Business members
7 routes. Paths are relative to https://api.intersink.com/v1.
- GET/business/{businessId}/act-for-owner/meAm I the owner, or acting for the owner, of this business?
- GET/business/{businessId}/membersList a business's members
- POST/business/{businessId}/membersInvite a member to a business
- PATCH/business/members/{memberId}Update a business member (permission/status)
- DELETE/business/members/{memberId}Remove a business member, or leave the business (your own active or suspended seat; not the owner)
- PUT/business/members/{memberId}/act-for-ownerOwner only, after step-up: let an active admin member act for the owner (billing, paid apps, developer) for 1–365 days
- DELETE/business/members/{memberId}/act-for-ownerEnd a member's permission to act for the owner (the owner, or the member themselves). Takes effect at once.
Am I the owner, or acting for the owner, of this business?
GET/business/{businessId}/act-for-owner/me
Needs a signed-in user (Bearer token or access_token cookie).
Parameters
| Name | Type | Description |
|---|---|---|
| businessIdrequired | string, path |
Response
200. The payload in data is not described in the spec yet.
List a business's members
GET/business/{businessId}/members
Needs a signed-in user (Bearer token or access_token cookie).
Parameters
| Name | Type | Description |
|---|---|---|
| businessIdrequired | string, path | |
| statusrequired | string, query | |
| qrequired | string, query | |
| pagerequired | string, query | |
| limitrequired | string, query |
Response
200. The payload in data is not described in the spec yet.
Invite a member to a business
POST/business/{businessId}/members
Needs a signed-in user (Bearer token or access_token cookie).
Parameters
| Name | Type | Description |
|---|---|---|
| businessIdrequired | string, path |
Request body application/json
| Field | Type | Description |
|---|---|---|
| emailrequired | string | Example: "[email protected]" |
| permissionrequired | string | One of: "admin", "manager", "editor", "view". Example: "manager" |
Response
201. The payload in data is not described in the spec yet.
Update a business member (permission/status)
PATCH/business/members/{memberId}
Needs a signed-in user (Bearer token or access_token cookie).
Parameters
| Name | Type | Description |
|---|---|---|
| memberIdrequired | string, path |
Request body application/json
| Field | Type | Description |
|---|---|---|
| permission | string | One of: "admin", "manager", "editor", "view". |
| status | string | One of: "active", "suspended". |
Response
200. The payload in data is not described in the spec yet.
Remove a business member, or leave the business (your own active or suspended seat; not the owner)
DELETE/business/members/{memberId}
Needs a signed-in user (Bearer token or access_token cookie).
Parameters
| Name | Type | Description |
|---|---|---|
| memberIdrequired | string, path |
Response
200. The payload in data is not described in the spec yet.
Owner only, after step-up: let an active admin member act for the owner (billing, paid apps, developer) for 1–365 days
PUT/business/members/{memberId}/act-for-owner
Needs a signed-in user (Bearer token or access_token cookie).
Parameters
| Name | Type | Description |
|---|---|---|
| memberIdrequired | string, path |
Request body application/json
| Field | Type | Description |
|---|---|---|
| days | number | Minimum 1, maximum 365. Example: 90 |
| scopes | string[] | What they may do for the owner (default: all) One of: "billing", "developer", "profile". |
| note | string | At most 200 characters. Example: "Runs billing while I travel" |
Response
200. The payload in data is not described in the spec yet.
End a member's permission to act for the owner (the owner, or the member themselves). Takes effect at once.
DELETE/business/members/{memberId}/act-for-owner
Needs a signed-in user (Bearer token or access_token cookie).
Parameters
| Name | Type | Description |
|---|---|---|
| memberIdrequired | string, path |
Response
200. The payload in data is not described in the spec yet.