Skip to navigation
How-to guides

How to create a form group

View as Markdown

This topic demonstrates how to create a form group for your Docusign Rooms for Real Estate account.

Run this code example from our Quickstart or launcher projects: Bash, C#, Java, Node.js, PHP, PowerShell, Python, or Ruby.

Required data

Running the code in this how-to requires this data:

Data elementDescription
{API_ACCOUNT_ID}A GUID value that identifies your account. This value is automatically generated by Docusign for any account you create. Copy the value from the API Account ID field on the Apps and Keys page.
{BASE_PATH}A string value that forms the root of the URL required to make API calls. The base path value in the example code is set to target the developer environment at
https://<domain>/restapi/v2
Where <domain> is demo.rooms.docusign.com for the developer environment and rooms.docusign.com for production.
Forms enabled on your Rooms accountThe user role needs the Manage form groups permission assigned. These permissions are only available to accounts with Forms enabled. To enable this feature, contact your Account Manager or Business Development representative.
Rooms enabled for your accountYou will need access enabled to use the Rooms API. See creating a Rooms developer account.

Step 1. Obtain your OAuth token

To make the API call shown in this how-to, you need a valid OAuth access token with the dtr.rooms.write scope enabled. Docusign supports access tokens for three different recommended OAuth grant types: Public Authorization Code Grant, Confidential Authorization Code Grant, and JSON Web Token (JWT) Grant. Choose the OAuth grant type appropriate for your scenario.

See Authentication for guidance on your options to get an OAuth token.

Three icons that represent the three methods a user can use to obtain an OAuth token: JSON Web Token (JWT), Public Authorization Code Grant (ACG), and Confidential Authorization Code grant

Step 2: Construct your API headers

After you have a valid OAuth access token, you are ready to construct the API headers that you will pass to the API call. Construct your headers like this, but make sure to substitute your valid OAuth access token for {ACCESS_TOKEN}.

declare -a Headers=('--header' "Authorization: Bearer ${ACCESS_TOKEN}"
    '--header' "Accept: application/json"
    '--header' "Content-Type: application/json")

Step 3. Construct the request body

Next, create the request body by providing a name for your form group.

printf \
    '
{
  "name": "Sample Room Form Group",
}' >$request_data

Step 4. Call the Rooms API

Now that you have constructed your API headers and request body, make a POST request to the FormGroups:CreateFormGroup method and include the request body to create a form group for your Rooms account.

Here’s how you make the call, but make sure to substitute your base path for {BASE_PATH} and your API account ID for {API_ACCOUNT_ID}.

View the source code for this example on GitHub: Bash, C#, Java, Node, PHP, PowerShell, Python, or Ruby.

Status=$(curl -w '%{http_code}' --request POST ${base_path}/restapi/v2/accounts/${API_ACCOUNT_ID}/form_groups \
    "${Headers[@]}" \
    --data-binary @${request_data} \
    --output ${response})

Expected response

If you run this code example from our Quickstart or launcher projects, you should see a JSON response similar to the code shown.

Sample response
{
  "formGroupId": "1e7eb41b-xxxx-xxxx-xxxx-18653f67a657",
  "name": "Sample Room Form Group",
  "officeIds": [],
  "forms": []
}

Next steps