Customers

Add Customer Members

Add members to a customer (external group). A user can be in at most one customer per organization. A new email will receive an invitation with role external-viewer (the invitation email is sent automatically)  <b><a target='_blank' href='https://evidence.dev/pricing'>Enterprise Only</a></b>

post/v1/workspaces/customers/members

Request

  • Base URL: https://management.evidence.studio
  • URL: https://management.evidence.studio/v1/workspaces/customers/members
  • Auth: one of:
    • API key in header Authorization
    • API key in cookie wos-session

Request body

customerIdstring required

Customer to add the members to (group_...)

emailsstring[] required

Email addresses to add (max 50 per batch, duplicates ignored)

Example request

{
  "customerId": "group_01J2ABC3DEF",
  "emails": [
    "jane.doe@acme.com",
    "john.doe@acme.com"
  ]
}

Response

Per-email results

Example response

{
  "results": {
    "successes": [
      {
        "email": "jane.doe@acme.com",
        "result": "invited",
        "inviteUrl": "https://studio.example.com/invitation?invitation_token=YNfaBZ6lcuNlFVg4Wmzn8UTp7"
      },
      {
        "email": "existing.viewer@acme.com",
        "result": "added"
      }
    ],
    "failures": [
      {
        "email": "admin.user@acme.com",
        "error": "This user is already a member with a non-viewer role"
      }
    ]
  }
}

Changes

No recorded changes to this operation across all 1 revision of this API.