Create or update multi-product user | Docusign

curl -X POST https://api-d.docusign.net/Management/v2.1/organizations/organizationId/accounts/accountId/users \
     -H "Authorization: Bearer <token>" \
     -H "Content-Type: application/json" \
     -d '{
  "product_permission_profiles": [
    {
      "product_id": "00000000-0000-0000-0000-000000000000",
      "permission_profile_id": "string"
    }
  ],
  "email": "string"
}'

{
  "id": "00000000-0000-0000-0000-000000000000",
  "site_id": 1,
  "user_name": "string",
  "first_name": "string",
  "last_name": "string",
  "email": "string",
  "language_culture": "string",
  "federated_status": "string",
  "accounts": [
    {
      "id": "00000000-0000-0000-0000-000000000000",
      "site_id": 1,
      "product_permission_profiles": [
        {
          "product_id": "00000000-0000-0000-0000-000000000000",
          "product_name": "string",
          "permission_profiles": [
            {
              "permission_profile_id": "string",
              "permission_profile_name": "string"
            }
          ],
          "error_message": "string"
        }
      ],
      "ds_groups": [
        {
          "ds_group_id": "00000000-0000-0000-0000-000000000000",
          "account_id": "00000000-0000-0000-0000-000000000000",
          "source_product_name": "string",
          "group_id": "string",
          "group_name": "string",
          "description": "string",
          "is_admin": true,
          "last_modified_on": "2024-01-15T09:30:00Z",
          "user_count": 1,
          "external_account_id": 1,
          "account_name": "string",
          "is_managed_by_scim": true
        }
      ],
      "company_name": "string",
      "job_title": "string",
      "license_status": "string",
      "license_type": "string",
      "plan_name": "string",
      "subscription_id": "string"
    }
  ]
}

This API endpoint enables you to either add a new user or update the details of an existing user within a specified organization and account.

Add a user: A new user is created when the provided email does not match an existing user in the given organizationId and accountId.
Update a user: An existing user is updated when the email matches a user already associated with the given organizationId and accountId.

Notes:

Duplicate emails are not allowed within the same organizationId and accountId. If multiple users with the same email exist, the request will fail with a 409 conflict error.

Required authentication scopes: user_write.

Next steps

Explore an example that demonstrates how to construct the request body and call the endpoint.

Authentication

AuthorizationBearer

OAuth2 Access code Grant

Path parameters

organizationIdstringRequiredformat: "uuid"

The organization ID.

accountIdstringRequiredformat: "uuid"

The account ID GUID

Request

This endpoint expects an object: request

product_permission_profileslist of objectsRequired

A list of one or more products and their respective permissions.

emailstringRequired

The email address.

ds_groupslist of objectsOptional

user_namestringOptional

The full name of the user.

first_namestringOptional

The user's first name.

last_namestringOptional

The user's last name.

default_account_idstringOptionalformat: "uuid"

language_culturestringOptional

The language and culture of the user.

Chinese Simplified: zh_CN
Chinese Traditional: zh_TW
Dutch: nl
English: en
French: fr
German: de
Italian: it
Japanese: ja
Korean: ko
Portuguese: pt
Portuguese Brazil: pt_BR
Russian: ru
Spanish: es

access_codestringOptional

The access code that the user needs to activate an account.

federated_statusstringOptional

The user’s federated status. One of:

RemoveStatus
FedAuthRequired
FedAuthBypass
Evicted

auto_activate_membershipsbooleanOptional

When true, the user’s account is activated automatically.

license_typestringOptional

The user’s assigned license type. Only available for IAM plans. Must be one of the following values:

Full - Enterprise: Full license type available for customers who purchase the IAM Enterprise plan; includes access to sending envelopes, Agreement Manager, and Workflow Builder.
Full - Professional: Full license type available for customers who purchase the IAM Professional plan; includes access to sending envelopes, Agreement Manager, and Workflow Builder.
Full - Standard: Full license type available for customers who purchase the IAM Standard plan; includes access to sending envelopes, Agreement Manager, and Workflow Builder.
Full - Sales: Full license type available for customers who purchase the IAM Sales plan; includes access to sending envelopes, Agreement Manager, and Workflow Builder.
Full - CX: Full license type available for customers who purchase the IAM Sales plan; includes access to sending envelopes and Workflow Builder.
Free: Free license type available for all IAM customers; includes access to viewing the user’s own agreements and signing.

Response

idstringOptionalformat: "uuid"

site_idintegerOptional