How to delete a Group using REST AP? | Adobe Sign

Objective

A group can be deleted from the account using the Adobe Sign online REST API page.

Environment

REST API Swagger App

Steps

Getting Group ID:

  1. Go to https://secure.na1.echosign.com/public/docs/restapi/v5.
  2. Under Resources and Operations, click groups.
  3. Click GET /groups.
  4. Click the oAuth Access-token button.
  5. Generate the Access token.
  6. Click the Try it out button.

You receive a response as following with the group name and Group ID:

{
  "groupInfoList": [
    {
      "groupId": "3AAABLblqZhB4o9EnlvmGB_m8CrG5O6XClTBO7vmojOOexu5r3G95LtEV2Sp7BuhNvQYSvWB7PmmwVPXnhPIiYSuHV98Cerkp",
      "groupName": "Default Group"
    },
    {
      "groupId": "3AAABLblqZhC3dPT6za5h7r1-BOEWivCe_OcAVONhcsKa57SL9_iCwGr5v_JED1No5jE20Pcjv0mYH2J-LoY1AcmqS69vRkO7",
      "groupName": "test"
    },
  ]
}

Deleting group:

  1. Click DELETE /groups/{groupId}.
  2. To generate Access Token, click the oAuth Access-token button.
  3. Add groupId received in the response of the previous call that you want to delete in groupId Box.
  4. Click Try it Out.

You receive a response as the following once Group is deleted.

No content

Additional information

Since Adobe Sign Web Interface does not have the option to delete, group REST API Swagger App can be useful for it.

You cannot delete a group, which has a user assigned. In the essence, you can delete only the empty Group. You receive a response as the following if there is a user in the group.

{
  "code": "GROUP_NOT_EMPTY",
  "message": "The group cannot be deleted because it is not empty."
}

Adobe, Inc.

Get help faster and easier

New user?