logo

Members

Endpoints related to managing members of the current hub.

List Hub Members

Requires the hubs-members-view capability.

SecuritybearerAuth
Request
query Parameters
include
Array of strings

A comma separated list of include values. Included resources will show up under the root document's include field, with the key being the id of the included resource. In the case of applying an include to a collection of resources, if two resources share the same include, it will only appear once in the return.

Items Enum: "senders" "hubs" "accounts" "roles"
sort
Array of strings

An array of sort values. To sort descending, put a - in front of the value, e.g. -id.

filter
object
object

In a list return, the data associated with the page number and size returned. 20 results per page, page 2 would be page[size]=20&page[number]=2

Responses
200

Returns a list of Hub Memberships.

default

General error response from the platform

get/v1/hubs/current/members
Response samples
application/json
{
  • "data": [
    ],
  • "includes": {
    }
}

Get Hub Membership

Gets the Hub Membership for the requesting Account.

SecuritybearerAuth
Request
query Parameters
include
Array of strings

A comma separated list of include values. Included resources will show up under the root document's include field, with the key being the id of the included resource. In the case of applying an include to a collection of resources, if two resources share the same include, it will only appear once in the return.

Items Enum: "senders" "hubs" "accounts" "roles"
sort
Array of strings

An array of sort values. To sort descending, put a - in front of the value, e.g. -id.

filter
object
object

In a list return, the data associated with the page number and size returned. 20 results per page, page 2 would be page[size]=20&page[number]=2

Responses
200

Returns a Hub Membership.

default

General error response from the platform

get/v1/hubs/current/membership
Response samples
application/json
{
  • "data": {
    },
  • "includes": {
    }
}

Get Hub Member

Requires the hubs-members-view capability.

SecuritybearerAuth
Request
path Parameters
memberId
required
string

The ID for the given Hub member.

query Parameters
include
Array of strings

A comma separated list of include values. Included resources will show up under the root document's include field, with the key being the id of the included resource. In the case of applying an include to a collection of resources, if two resources share the same include, it will only appear once in the return.

Items Enum: "senders" "hubs" "accounts" "roles"
Responses
200

Returns a Hub Membership.

default

General error response from the platform

get/v1/hubs/current/members/{memberId}
Response samples
application/json
{
  • "data": {
    },
  • "includes": {
    }
}

Update Hub Member

Requires the hubs-members-manage capability.

SecuritybearerAuth
Request
path Parameters
memberId
required
string

The ID for the given member.

Request Body schema: application/json

Parameters for updating a Hub membership.

role_id
string <objectid> (ID)

The account role.

object (Permissions)

Permissions information for an API Key

Responses
200

Returns a Hub Membership.

default

General error response from the platform

patch/v1/hubs/current/members/{memberId}
Request samples
application/json
{
  • "role_id": "651586fca6078e98982dbd90",
  • "permissions": {
    }
}
Response samples
application/json
{
  • "data": {
    }
}

Delete Hub Member

Requires the hubs-members-manage capability.

SecuritybearerAuth
Request
path Parameters
memberId
required
string

The ID of the given Hub Member.

Responses
202

Returns a Job Descriptor.

default

General error response from the platform

delete/v1/hubs/current/members/{memberId}
Response samples
application/json
{
  • "data": {
    }
}

Get Hub Member Account

Requires the hubs-members-view capability.

SecuritybearerAuth and hubAuth
Request
path Parameters
accountId
required
string

The ID of the member's Account.

query Parameters
meta
Array of strings

A comma separated list of meta values. Meta values will show up under a resource's meta field. In the case of applying a meta to a collection of resources, each resource will have it's own relevant meta data. In some rare cases, meta may not apply to individual resources, and may appear in the root document. These will be clearly labeled.

Items Value: "capabilities"
include
Array of strings

A comma separated list of include values. Included resources will show up under the root document's include field, with the key being the id of the included resource. In the case of applying an include to a collection of resources, if two resources share the same include, it will only appear once in the return.

Items Enum: "senders" "hubs" "accounts" "roles"
Responses
200

Returns a Hub Membership.

default

General error response from the platform

get/v1/hubs/current/members/account/{accountId}
Response samples
application/json
{
  • "data": {
    },
  • "includes": {
    }
}

List Hub Invites

Requires the hubs-invites-manage capability.

SecuritybearerAuth
Request
query Parameters
meta
Array of strings

A comma separated list of meta values. Meta values will show up under a resource's meta field. In the case of applying a meta to a collection of resources, each resource will have it's own relevant meta data. In some rare cases, meta may not apply to individual resources, and may appear in the root document. These will be clearly labeled.

Items Value: "capabilities"
include
Array of strings

A comma separated list of include values. Included resources will show up under the root document's include field, with the key being the id of the included resource. In the case of applying an include to a collection of resources, if two resources share the same include, it will only appear once in the return.

Items Enum: "senders" "hubs" "accounts"
sort
Array of strings

An array of sort values. To sort descending, put a - in front of the value, e.g. -id.

filter
object
object

In a list return, the data associated with the page number and size returned. 20 results per page, page 2 would be page[size]=20&page[number]=2

Responses
200

Returns a list of Memberships.

default

General error response from the platform

get/v1/hubs/current/invites
Response samples
application/json
{
  • "data": [
    ],
  • "includes": {
    }
}

Create Hub Invite

Requires the hubs-invites-send capability.

SecuritybearerAuth and hubAuth
Request
Request Body schema: application/json

Parameters for creating a Hub invite.

recipient
string

The email address of the invitee.

role_id
string <objectid> (ID)

The account role.

object

The Environment permissions the invitee will have

Responses
201

Returns a Hub Membership.

default

General error response from the platform

post/v1/hubs/current/invites
Request samples
application/json
{
  • "recipient": "string",
  • "role_id": "651586fca6078e98982dbd90",
  • "permissions": {
    }
}
Response samples
application/json
{
  • "data": {
    }
}

Delete Hub Invite

Requires the hub-invites-manage capability.

SecuritybearerAuth
Request
path Parameters
inviteId
required
string

The ID of the Hub Invite.

Responses
200

Returns a Hub Membership.

default

General error response from the platform

delete/v1/hubs/current/invites/{inviteId}
Response samples
application/json
{
  • "data": {
    }
}
➔ Next to Notifications