Skip to main content
PATCH
/
v1
/
organizations
Bulk Update Organizations
curl --request PATCH \
  --url https://api.us.lexful.app/v1/organizations \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --header 'X-Account-ID: <api-key>' \
  --data '
[
  {
    "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
    "name": "<string>",
    "slug": "<string>",
    "type": "<string>",
    "status": "<string>",
    "description": "<string>",
    "logo_url": "<string>",
    "website_url": "<string>",
    "notes": "<string>",
    "alert": "<string>",
    "parent_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a"
  }
]
'
import requests

url = "https://api.us.lexful.app/v1/organizations"

payload = [
{
"id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"name": "<string>",
"slug": "<string>",
"type": "<string>",
"status": "<string>",
"description": "<string>",
"logo_url": "<string>",
"website_url": "<string>",
"notes": "<string>",
"alert": "<string>",
"parent_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a"
}
]
headers = {
"Authorization": "Bearer <token>",
"X-Account-ID": "<api-key>",
"Content-Type": "application/json"
}

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

print(response.text)
const options = {
method: 'PATCH',
headers: {
Authorization: 'Bearer <token>',
'X-Account-ID': '<api-key>',
'Content-Type': 'application/json'
},
body: JSON.stringify([
{
id: '3c90c3cc-0d44-4b50-8888-8dd25736052a',
name: '<string>',
slug: '<string>',
type: '<string>',
status: '<string>',
description: '<string>',
logo_url: '<string>',
website_url: '<string>',
notes: '<string>',
alert: '<string>',
parent_id: '3c90c3cc-0d44-4b50-8888-8dd25736052a'
}
])
};

fetch('https://api.us.lexful.app/v1/organizations', 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.us.lexful.app/v1/organizations",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "PATCH",
CURLOPT_POSTFIELDS => json_encode([
[
'id' => '3c90c3cc-0d44-4b50-8888-8dd25736052a',
'name' => '<string>',
'slug' => '<string>',
'type' => '<string>',
'status' => '<string>',
'description' => '<string>',
'logo_url' => '<string>',
'website_url' => '<string>',
'notes' => '<string>',
'alert' => '<string>',
'parent_id' => '3c90c3cc-0d44-4b50-8888-8dd25736052a'
]
]),
CURLOPT_HTTPHEADER => [
"Authorization: Bearer <token>",
"Content-Type: application/json",
"X-Account-ID: <api-key>"
],
]);

$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.us.lexful.app/v1/organizations"

payload := strings.NewReader("[\n {\n \"id\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\",\n \"name\": \"<string>\",\n \"slug\": \"<string>\",\n \"type\": \"<string>\",\n \"status\": \"<string>\",\n \"description\": \"<string>\",\n \"logo_url\": \"<string>\",\n \"website_url\": \"<string>\",\n \"notes\": \"<string>\",\n \"alert\": \"<string>\",\n \"parent_id\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\"\n }\n]")

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

req.Header.Add("Authorization", "Bearer <token>")
req.Header.Add("X-Account-ID", "<api-key>")
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.patch("https://api.us.lexful.app/v1/organizations")
.header("Authorization", "Bearer <token>")
.header("X-Account-ID", "<api-key>")
.header("Content-Type", "application/json")
.body("[\n {\n \"id\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\",\n \"name\": \"<string>\",\n \"slug\": \"<string>\",\n \"type\": \"<string>\",\n \"status\": \"<string>\",\n \"description\": \"<string>\",\n \"logo_url\": \"<string>\",\n \"website_url\": \"<string>\",\n \"notes\": \"<string>\",\n \"alert\": \"<string>\",\n \"parent_id\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\"\n }\n]")
.asString();
require 'uri'
require 'net/http'

url = URI("https://api.us.lexful.app/v1/organizations")

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

request = Net::HTTP::Patch.new(url)
request["Authorization"] = 'Bearer <token>'
request["X-Account-ID"] = '<api-key>'
request["Content-Type"] = 'application/json'
request.body = "[\n {\n \"id\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\",\n \"name\": \"<string>\",\n \"slug\": \"<string>\",\n \"type\": \"<string>\",\n \"status\": \"<string>\",\n \"description\": \"<string>\",\n \"logo_url\": \"<string>\",\n \"website_url\": \"<string>\",\n \"notes\": \"<string>\",\n \"alert\": \"<string>\",\n \"parent_id\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\"\n }\n]"

response = http.request(request)
puts response.read_body
{
  "items": [
    {
      "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
      "is_primary": true,
      "name": "<string>",
      "slug": "<string>",
      "type": "<string>",
      "status": "<string>",
      "description": "<string>",
      "logo_url": "<string>",
      "website_url": "<string>",
      "notes": "<string>",
      "alert": "<string>",
      "parent_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
      "tags": [
        {
          "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
          "name": "<string>",
          "color": "<string>"
        }
      ],
      "created_at": "2023-11-07T05:31:56Z",
      "updated_at": "2023-11-07T05:31:56Z",
      "created_by": "<string>",
      "updated_by": "<string>",
      "deleted_at": "2023-11-07T05:31:56Z"
    }
  ],
  "total": 123
}
{
"status": 123,
"message": "<string>",
"error_id": "<string>",
"error_code": "<string>",
"developer_message": "<string>"
}
{
"status": 123,
"message": "<string>",
"error_id": "<string>",
"error_code": "<string>",
"developer_message": "<string>"
}
{
"status": 123,
"message": "<string>",
"error_id": "<string>",
"error_code": "<string>",
"developer_message": "<string>"
}

Authorizations

Authorization
string
header
required

Bearer token

X-Account-ID
string
header
required

Account ID

Body

application/json
Required array length: 1 - 100 elements
id
string<uuid>
required

Organization ID to update

name
string

Organization name

Required string length: 1 - 255
slug
string

Organization slug

Pattern: ^[a-z0-9_-]+$
type
string

Organization type

status
string

Organization status

description
string | null

Organization description

logo_url
string<uri> | null

Organization logo URL

website_url
string<uri> | null

Organization website URL

notes
string | null

Internal notes

alert
string | null

Alert message

parent_id
string<uuid> | null

Parent organization ID

asset_management
enum<string>

Asset management status - controls entity CRUD operations

Available options:
disabled,
enabled,
read_only

Response

Default Response

items
object[]
required
total
number
required