update entity by id

curl --request PUT \
  --url https://api.example.com/api/v1/invite/{id} \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "expiredAt": 1,
  "roles": [
    "extractor-user",
    "organisation-user"
  ]
}
'

import requests

url = "https://api.example.com/api/v1/invite/{id}"

payload = {
    "expiredAt": 1,
    "roles": ["extractor-user", "organisation-user"]
}
headers = {
    "Authorization": "Bearer <token>",
    "Content-Type": "application/json"
}

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

print(response.text)

const options = {
  method: 'PUT',
  headers: {Authorization: 'Bearer <token>', 'Content-Type': 'application/json'},
  body: JSON.stringify({expiredAt: 1, roles: ['extractor-user', 'organisation-user']})
};

fetch('https://api.example.com/api/v1/invite/{id}', 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.example.com/api/v1/invite/{id}",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "PUT",
  CURLOPT_POSTFIELDS => json_encode([
    'expiredAt' => 1,
    'roles' => [
        'extractor-user',
        'organisation-user'
    ]
  ]),
  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.example.com/api/v1/invite/{id}"

	payload := strings.NewReader("{\n  \"expiredAt\": 1,\n  \"roles\": [\n    \"extractor-user\",\n    \"organisation-user\"\n  ]\n}")

	req, _ := http.NewRequest("PUT", 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.put("https://api.example.com/api/v1/invite/{id}")
  .header("Authorization", "Bearer <token>")
  .header("Content-Type", "application/json")
  .body("{\n  \"expiredAt\": 1,\n  \"roles\": [\n    \"extractor-user\",\n    \"organisation-user\"\n  ]\n}")
  .asString();

require 'uri'
require 'net/http'

url = URI("https://api.example.com/api/v1/invite/{id}")

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

request = Net::HTTP::Put.new(url)
request["Authorization"] = 'Bearer <token>'
request["Content-Type"] = 'application/json'
request.body = "{\n  \"expiredAt\": 1,\n  \"roles\": [\n    \"extractor-user\",\n    \"organisation-user\"\n  ]\n}"

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

{
  "email": "<string>",
  "roles": [
    "<string>"
  ],
  "id": 1,
  "createdAt": 123,
  "updatedAt": 123,
  "tenantId": 123,
  "organisationId": 123,
  "expiredAt": 123
}

PUT

api

invite

{id}

update entity by id

curl --request PUT \
  --url https://api.example.com/api/v1/invite/{id} \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "expiredAt": 1,
  "roles": [
    "extractor-user",
    "organisation-user"
  ]
}
'

import requests

url = "https://api.example.com/api/v1/invite/{id}"

payload = {
    "expiredAt": 1,
    "roles": ["extractor-user", "organisation-user"]
}
headers = {
    "Authorization": "Bearer <token>",
    "Content-Type": "application/json"
}

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

print(response.text)

const options = {
  method: 'PUT',
  headers: {Authorization: 'Bearer <token>', 'Content-Type': 'application/json'},
  body: JSON.stringify({expiredAt: 1, roles: ['extractor-user', 'organisation-user']})
};

fetch('https://api.example.com/api/v1/invite/{id}', 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.example.com/api/v1/invite/{id}",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "PUT",
  CURLOPT_POSTFIELDS => json_encode([
    'expiredAt' => 1,
    'roles' => [
        'extractor-user',
        'organisation-user'
    ]
  ]),
  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.example.com/api/v1/invite/{id}"

	payload := strings.NewReader("{\n  \"expiredAt\": 1,\n  \"roles\": [\n    \"extractor-user\",\n    \"organisation-user\"\n  ]\n}")

	req, _ := http.NewRequest("PUT", 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.put("https://api.example.com/api/v1/invite/{id}")
  .header("Authorization", "Bearer <token>")
  .header("Content-Type", "application/json")
  .body("{\n  \"expiredAt\": 1,\n  \"roles\": [\n    \"extractor-user\",\n    \"organisation-user\"\n  ]\n}")
  .asString();

require 'uri'
require 'net/http'

url = URI("https://api.example.com/api/v1/invite/{id}")

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

request = Net::HTTP::Put.new(url)
request["Authorization"] = 'Bearer <token>'
request["Content-Type"] = 'application/json'
request.body = "{\n  \"expiredAt\": 1,\n  \"roles\": [\n    \"extractor-user\",\n    \"organisation-user\"\n  ]\n}"

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

{
  "email": "<string>",
  "roles": [
    "<string>"
  ],
  "id": 1,
  "createdAt": 123,
  "updatedAt": 123,
  "tenantId": 123,
  "organisationId": 123,
  "expiredAt": 123
}

Authorizations

Authorization

string

header

required

Authentication

Path Parameters

integer<int64>

required

Body

application/json

expiredAt

integer<int64>

Expiration time of the invite

Required range: x >= 0

roles

string[]

Roles for invited user

Example:

["extractor-user", "organisation-user"]

Response

200 - application/json

string

required

Email for which this Invite was generated

roles

string[]

required

Roles for invited user

Minimum array length: 1

integer<int64>

Unique identifier of the entity

Example:

1

createdAt

integer<int64>

Time when entity was created

updatedAt

integer<int64>

Time when entity was updated

tenantId

integer<int64>

ID of the tenant

organisationId

integer<int64>

ID of the organisation

expiredAt

integer<int64>

Time when this invite will be expired

Overview

Action Route

Admin Route

Api Key Route

Contract Audit Route

Contract Route

Tenant Destination Route

Detector Route

License Instance Route

License Instance Meta Route

Invite Route

License Route

License Score Group Route

Network Route

Organisation Route

Plan Route

Project Route

Project Documentation Route

Registration Route

Detector Schema Route

Score Route

Score Group Route

Subscription Route

Syslog Route

Tenant Route

Tokenomics Category Route

Tokenomics Schedule Route

Trigger Route

User Route

Wallet Route

Telegram Route

Auth Route

Swagger Specs Route

update entity by id

Authorizations

Path Parameters

Body

Response