Members

Members form the body of your Workspace. They can be accessed through a variety of endpoints, depending on how you wish them to be grouped.

For information on how to add and remove Members from Audiences, please refer to the Audiences documentation.

Create or modify Members

POST https://api.orbiit.ai/v0/workspaces/:workspaceId/members

Create new Members in a given Workspace, or, if partial data is matched for any of the Members in the submission, update those Members with the provided data.

Path Parameters

Name	Type	Description
workspaceId*	String	Your Workspace ID

Request Body

Name	Type	Description
*.email*	String	Member Email
*.firstName*	String
*.lastName	String
*.role	String	The job-title / role of the Member
*.company	String	Company name for the Member
members*	Array	Array with member Objects, denoted below with *.

Retrieve a list of Members by Workspace

GET https://api.orbiit.ai/v0/workspaces/:workspaceId/members

Retrieve all of the Members belonging to a given Workspace. Optionally you can filter using an Audience ID.

Path Parameters

Name	Type	Description
workspaceId*	String	Your workspace ID

Query Parameters

Name	Type	Description
audienceId	String	Optional audience ID

200: OK

{
    "totalCount": 100,
    "nodes": [
        {
            "_id": "3062636f713871746175756b",
            "email": "[email protected]",
            "fields": {
                "first_name": "Timothy",
                "last_name": "Tester",
                "role": "QA Tester",
                "company": "Example, Inc.",
            }
        },
        ...
    ],
    "pageInfo": {
        "startCursor": "eyJpZCI6IjMwNjI2MzZmNzEzODcxNzQ2MTc1NzU2YiJ9",
        "endCursor": "eyJpZCI6IjM4MzU3MzY0NzE3NDYzNzc3Mjc0MzMzOCJ9"
    }
}

Delete Members from a Workspace

DELETE https://api.orbiit.ai/v0/workspaces/:workspaceId/members

Path Parameters

Name	Type	Description
workspaceId*	String	The workspace ID

Request Body

Name	Type	Description
memberIds*	Array[String]	Array of Member IDs