Create a Group

This page is no longer maintained (Mar 29, 2023). For the most current information, go to https://docs.snaplogic.com/public-apis/post-groups.html.

 

POST /groups

Overview

This API creates a group.

To create the group and add its members,

  1. Verify that the target Org exists.

  2. Create the group using this API.

  3. Add the members to the group using this API.

IMPORTANT: Avoid space characters in your Group name; instead, use underscores.

Prerequisites

You need:

  • Org Admin permissions.

Request

Path Parameters

Key

Description

Key

Description

pod_path

Required. The path to your SnapLogic pod.

Example: elastic.snaplogic.com

Query Parameters

None.

Request Header

Specify Basic for authorization and application/json for content type.

Request Body

{ "organization" : "...", "name" : "...", "members" : [ ... ] }

Key

Type

Description

Key

Type

Description

organization

string

The Org to create the group in.

name

string

Required. The name of the group.

members

array

An array of strings containing email addresses of users to add to the group.

Response

Status code only.