​
Introduction

Inviting users to an account is a common operation in collaborative workflows. This guide demonstrates how to automate the process of inviting multiple users to an account by specifying their email addresses, roles, and associated workspaces. By following these examples, you can streamline the user onboarding process and integrate it into your existing workflows.

Each example in this guide begins with obtaining an authorization token from the Mudstack API and setting the required headers (Authorization, x-workspace-id, and x-account-id) for every request. These steps ensure secure and properly scoped API interactions.

Authentication is a critical step in interacting with the Mudstack API. Each request requires an authorization token, which is obtained using your API key and secret. Additionally, the x-workspace-id and x-account-id headers must be included in every request to ensure proper scoping.

This example is particularly useful for scenarios such as:

  • Onboarding new team members to an account.
  • Assigning roles and workspace access during the invitation process.
  • Automating user invitations for large teams.

This example demonstrates how to:

  1. Authenticate and retrieve an authorization token.
  2. Invite multiple users to an account using the /accounts/invites endpoint.

​
Steps

​
Step 1: Authenticate and Retrieve an Authorization Token

Use the /auth/token endpoint to retrieve an authorization token. Replace <your_account_id>, <your_key>, and <your_secret> with your account ID, API key, and secret, respectively.

# Python example to retrieve an authorization token
import requests

url = "https://api.mudstack.com/auth/token"
data = {
    "account_id": "<your_account_id>",
    "key": "<your_key>",
    "secret": "<your_secret>"
}
response = requests.post(url, json=data)
token = response.json()["token"]
print(token)

Response Example:

{
  "token": "your_generated_token"
}

​
Step 2: Invite Users to an Account

Use the /accounts/invites endpoint to invite users to an account. Replace <your_token>, <workspace_id>, and <account_id> with your authorization token, workspace ID, and account ID, respectively. Provide the list of users to invite, including their email addresses, roles, and associated workspaces.

# Python example to invite users
import requests

# Step 1: Authenticate
auth_url = "https://api.mudstack.com/auth/token"
auth_data = {
    "account_id": "<your_account_id>",
    "key": "<your_key>",
    "secret": "<your_secret>"
}
auth_response = requests.post(auth_url, json=auth_data)
token = auth_response.json()["token"]

# Step 2: Invite users
url = "https://api.mudstack.com/accounts/invites"
headers = {
    "Authorization": f"Bearer {token}",
    "x-workspace-id": "<workspace_id>",
    "x-account-id": "<account_id>",
    "Content-Type": "application/json"
}
data = {
    "invites": [
        {
            "email": "user1@example.com",
            "roles": ["Editor"],
            "workspace_ids": ["workspace1"]
        },
        {
            "email": "user2@example.com",
            "roles": ["Viewer"],
            "workspace_ids": ["workspace2", "workspace3"]
        }
    ]
}
response = requests.post(url, headers=headers, json=data)
print(response.json())

Response Example:

{
  "invites": [
    {
      "email": "user1@example.com",
      "status": "sent"
    },
    {
      "email": "user2@example.com",
      "status": "sent"
    }
  ]
}

​
Explore More Examples

Looking for more examples? Check out the following guides to learn about other use cases:

Was this page helpful?