Invite Users

POST /v3/enterprise/members/users

Invite Users

cURL

curl --request POST \
  --url https://api.devin.ai/v3/enterprise/members/users \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "emails": [
    "<string>"
  ],
  "enterprise_role_id": "<string>"
}
'

import requests

url = "https://api.devin.ai/v3/enterprise/members/users"

payload = {
    "emails": ["<string>"],
    "enterprise_role_id": "<string>"
}
headers = {
    "Authorization": "Bearer <token>",
    "Content-Type": "application/json"
}

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

print(response.text)

const options = {
  method: 'POST',
  headers: {Authorization: 'Bearer <token>', 'Content-Type': 'application/json'},
  body: JSON.stringify({emails: ['<string>'], enterprise_role_id: '<string>'})
};

fetch('https://api.devin.ai/v3/enterprise/members/users', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

<?php

$curl = curl_init();

curl_setopt_array($curl, [
  CURLOPT_URL => "https://api.devin.ai/v3/enterprise/members/users",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "POST",
  CURLOPT_POSTFIELDS => json_encode([
    'emails' => [
        '<string>'
    ],
    'enterprise_role_id' => '<string>'
  ]),
  CURLOPT_HTTPHEADER => [
    "Authorization: Bearer <token>",
    "Content-Type: application/json"
  ],
]);

$response = curl_exec($curl);
$err = curl_error($curl);

curl_close($curl);

if ($err) {
  echo "cURL Error #:" . $err;
} else {
  echo $response;
}

package main

import (
	"fmt"
	"strings"
	"net/http"
	"io"
)

func main() {

	url := "https://api.devin.ai/v3/enterprise/members/users"

	payload := strings.NewReader("{\n  \"emails\": [\n    \"<string>\"\n  ],\n  \"enterprise_role_id\": \"<string>\"\n}")

	req, _ := http.NewRequest("POST", url, payload)

	req.Header.Add("Authorization", "Bearer <token>")
	req.Header.Add("Content-Type", "application/json")

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)

	fmt.Println(string(body))

}

HttpResponse<String> response = Unirest.post("https://api.devin.ai/v3/enterprise/members/users")
  .header("Authorization", "Bearer <token>")
  .header("Content-Type", "application/json")
  .body("{\n  \"emails\": [\n    \"<string>\"\n  ],\n  \"enterprise_role_id\": \"<string>\"\n}")
  .asString();

require 'uri'
require 'net/http'

url = URI("https://api.devin.ai/v3/enterprise/members/users")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Post.new(url)
request["Authorization"] = 'Bearer <token>'
request["Content-Type"] = 'application/json'
request.body = "{\n  \"emails\": [\n    \"<string>\"\n  ],\n  \"enterprise_role_id\": \"<string>\"\n}"

response = http.request(request)
puts response.read_body

200

[
  {
    "email": "<string>",
    "name": "<string>",
    "role_assignments": [
      {
        "role": {
          "role_id": "<string>",
          "role_name": "<string>"
        },
        "org_id": "<string>"
      }
    ],
    "user_id": "<string>"
  }
]

{
  "status": 123,
  "title": "<string>",
  "detail": "<string>",
  "errors": [
    {}
  ],
  "instance": "<string>",
  "type": "about:blank"
}

{
  "status": 123,
  "title": "<string>",
  "detail": "<string>",
  "errors": [
    {}
  ],
  "instance": "<string>",
  "type": "about:blank"
}

{
  "status": 123,
  "title": "<string>",
  "detail": "<string>",
  "errors": [
    {}
  ],
  "instance": "<string>",
  "type": "about:blank"
}

{
  "status": 123,
  "title": "<string>",
  "detail": "<string>",
  "errors": [
    {}
  ],
  "instance": "<string>",
  "type": "about:blank"
}

{
  "status": 123,
  "title": "<string>",
  "detail": "<string>",
  "errors": [
    {}
  ],
  "instance": "<string>",
  "type": "about:blank"
}

{
  "status": 123,
  "title": "<string>",
  "detail": "<string>",
  "errors": [
    {}
  ],
  "instance": "<string>",
  "type": "about:blank"
}

This endpoint creates direct role assignments for invited users. To manage membership through IDP groups, use the IDP group role management endpoints.

Permissions

Requires a service user with the ManageAccountMembership permission at the enterprise level.

Authorizations

Authorization · string · header · required

Service User credential (prefix: cog_)

Body

application/json

emails · string[] · required

Maximum array length: 100

enterprise_role_id · string · required

Response

200

application/json

Successful Response

email · string | null · required

name · string | null · required

role_assignments · RoleAssignment · object[] · required

Show child attributes

user_id · string · required