Add team members - NeetoSign API

Add team members

curl --request POST \
  --url https://{your-subdomain}.neetosign.com/api/external/v2/team-members \
  --header 'Accept: <accept>' \
  --header 'Content-Type: application/json' \
  --header 'X-Api-Key: <x-api-key>' \
  --data '
{
  "emails": [
    "[email protected]",
    "[email protected]"
  ],
  "organization_role": "Standard",
  "invited_by": "[email protected]",
  "send_invitation_email": true
}
'

const options = {
  method: 'POST',
  headers: {
    'X-Api-Key': '<x-api-key>',
    Accept: '<accept>',
    'Content-Type': 'application/json'
  },
  body: JSON.stringify({
    emails: ['[email protected]', '[email protected]'],
    organization_role: 'Standard',
    invited_by: '[email protected]',
    send_invitation_email: true
  })
};

fetch('https://{your-subdomain}.neetosign.com/api/external/v2/team-members', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

import requests

url = "https://{your-subdomain}.neetosign.com/api/external/v2/team-members"

payload = {
    "emails": ["[email protected]", "[email protected]"],
    "organization_role": "Standard",
    "invited_by": "[email protected]",
    "send_invitation_email": True
}
headers = {
    "X-Api-Key": "<x-api-key>",
    "Accept": "<accept>",
    "Content-Type": "application/json"
}

response = requests.post(url, json=payload, headers=headers)

print(response.text)

{
  "message": "Users added successfully"
}

POST

/

team-members

Add team members

curl --request POST \
  --url https://{your-subdomain}.neetosign.com/api/external/v2/team-members \
  --header 'Accept: <accept>' \
  --header 'Content-Type: application/json' \
  --header 'X-Api-Key: <x-api-key>' \
  --data '
{
  "emails": [
    "[email protected]",
    "[email protected]"
  ],
  "organization_role": "Standard",
  "invited_by": "[email protected]",
  "send_invitation_email": true
}
'

const options = {
  method: 'POST',
  headers: {
    'X-Api-Key': '<x-api-key>',
    Accept: '<accept>',
    'Content-Type': 'application/json'
  },
  body: JSON.stringify({
    emails: ['[email protected]', '[email protected]'],
    organization_role: 'Standard',
    invited_by: '[email protected]',
    send_invitation_email: true
  })
};

fetch('https://{your-subdomain}.neetosign.com/api/external/v2/team-members', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

import requests

url = "https://{your-subdomain}.neetosign.com/api/external/v2/team-members"

payload = {
    "emails": ["[email protected]", "[email protected]"],
    "organization_role": "Standard",
    "invited_by": "[email protected]",
    "send_invitation_email": True
}
headers = {
    "X-Api-Key": "<x-api-key>",
    "Accept": "<accept>",
    "Content-Type": "application/json"
}

response = requests.post(url, json=payload, headers=headers)

print(response.text)

{
  "message": "Users added successfully"
}

Replace {your-subdomain} with your workspace’s subdomain.
Learn how to find your subdomain in Workspace subdomain.

Headers

X-Api-Key

string

required

Use the X-Api-Key header to provide your workspace API key. Refer to Authentication for more information.

Accept

enum<string>

default:application/json

required

Specifies the expected response format. Must be set to application/json for proper API communication.

Available options:

application/json

Body

application/json

emails

string<email>[]

required

Emails of the team members to be added in the workspace in array format. Must be valid emails.

Example:

["[email protected]", "[email protected]"]

organization_role

string

Role that should be assigned to the new team members. It must be a valid role from the "Roles" section in the settings page. The default is "Standard".

Example:

"Standard"

invited_by

string<email>

Email of the admin sending the invitation. Defaults to the most recent workspace admin if not specified.

Example:

"[email protected]"

send_invitation_email

boolean

default:true

Set to false to skip sending invitation emails. Defaults to true.

Response

201 - application/json

Created - Users added successfully

message

string

Example:

"Users added successfully"