Update collaborator roles
Updates the role assignments for a collaborator.
Legacy note: this endpoint is maintained for existing V2 integrations. Prefer V3 for new API and agent workflows where an equivalent exists.
curl -X PATCH "https://api.textmine.com/v1/collaborators/example_string/roles" \
-H "Content-Type: application/json" \
-H "Authorization: Bearer YOUR_API_TOKEN" \
-d '{
"roles": [
"party",
"collaborator"
],
"fields": [
{
"id": 1932,
"label": "Address",
"value": "ADDRESS 2"
},
{
"id": 1937,
"label": "Last Name",
"value": "LAST NAME 2"
},
{
"id": 1938,
"label": "Position",
"options": [
{
"name": "CEO"
},
{
"name": "CTO"
},
{
"name": "Chairman"
},
{
"name": "Director"
},
{
"name": "Trustee"
},
{
"name": "Legal Counsel"
},
{
"name": "Manager"
},
{
"name": "Candidate"
}
],
"value": "Director"
},
{
"id": 1939,
"label": "First Name",
"value": "NAME 2"
},
{
"id": 1946,
"label": "Email",
"validationType": "EMAIL",
"value": "example@example.com"
}
]
}'
import requests
import json
url = "https://api.textmine.com/v1/collaborators/example_string/roles"
headers = {
"Content-Type": "application/json",
"Authorization": "Bearer YOUR_API_TOKEN"
}
data = {
"roles": [
"party",
"collaborator"
],
"fields": [
{
"id": 1932,
"label": "Address",
"value": "ADDRESS 2"
},
{
"id": 1937,
"label": "Last Name",
"value": "LAST NAME 2"
},
{
"id": 1938,
"label": "Position",
"options": [
{
"name": "CEO"
},
{
"name": "CTO"
},
{
"name": "Chairman"
},
{
"name": "Director"
},
{
"name": "Trustee"
},
{
"name": "Legal Counsel"
},
{
"name": "Manager"
},
{
"name": "Candidate"
}
],
"value": "Director"
},
{
"id": 1939,
"label": "First Name",
"value": "NAME 2"
},
{
"id": 1946,
"label": "Email",
"validationType": "EMAIL",
"value": "example@example.com"
}
]
}
response = requests.patch(url, headers=headers, json=data)
print(response.json())
const response = await fetch("https://api.textmine.com/v1/collaborators/example_string/roles", {
method: "PATCH",
headers: {
"Content-Type": "application/json",
"Authorization": "Bearer YOUR_API_TOKEN"
},
body: JSON.stringify({
"roles": [
"party",
"collaborator"
],
"fields": [
{
"id": 1932,
"label": "Address",
"value": "ADDRESS 2"
},
{
"id": 1937,
"label": "Last Name",
"value": "LAST NAME 2"
},
{
"id": 1938,
"label": "Position",
"options": [
{
"name": "CEO"
},
{
"name": "CTO"
},
{
"name": "Chairman"
},
{
"name": "Director"
},
{
"name": "Trustee"
},
{
"name": "Legal Counsel"
},
{
"name": "Manager"
},
{
"name": "Candidate"
}
],
"value": "Director"
},
{
"id": 1939,
"label": "First Name",
"value": "NAME 2"
},
{
"id": 1946,
"label": "Email",
"validationType": "EMAIL",
"value": "example@example.com"
}
]
})
});
const data = await response.json();
console.log(data);
package main
import (
"fmt"
"net/http"
"bytes"
"encoding/json"
)
func main() {
data := []byte(`{
"roles": [
"party",
"collaborator"
],
"fields": [
{
"id": 1932,
"label": "Address",
"value": "ADDRESS 2"
},
{
"id": 1937,
"label": "Last Name",
"value": "LAST NAME 2"
},
{
"id": 1938,
"label": "Position",
"options": [
{
"name": "CEO"
},
{
"name": "CTO"
},
{
"name": "Chairman"
},
{
"name": "Director"
},
{
"name": "Trustee"
},
{
"name": "Legal Counsel"
},
{
"name": "Manager"
},
{
"name": "Candidate"
}
],
"value": "Director"
},
{
"id": 1939,
"label": "First Name",
"value": "NAME 2"
},
{
"id": 1946,
"label": "Email",
"validationType": "EMAIL",
"value": "example@example.com"
}
]
}`)
req, err := http.NewRequest("PATCH", "https://api.textmine.com/v1/collaborators/example_string/roles", bytes.NewBuffer(data))
if err != nil {
panic(err)
}
req.Header.Set("Content-Type", "application/json")
req.Header.Set("Authorization", "Bearer YOUR_API_TOKEN")
client := &http.Client{}
resp, err := client.Do(req)
if err != nil {
panic(err)
}
defer resp.Body.Close()
fmt.Println("Response Status:", resp.Status)
}
require 'net/http'
require 'json'
uri = URI('https://api.textmine.com/v1/collaborators/example_string/roles')
http = Net::HTTP.new(uri.host, uri.port)
http.use_ssl = true
request = Net::HTTP::Patch.new(uri)
request['Content-Type'] = 'application/json'
request['Authorization'] = 'Bearer YOUR_API_TOKEN'
request.body = '{
"roles": [
"party",
"collaborator"
],
"fields": [
{
"id": 1932,
"label": "Address",
"value": "ADDRESS 2"
},
{
"id": 1937,
"label": "Last Name",
"value": "LAST NAME 2"
},
{
"id": 1938,
"label": "Position",
"options": [
{
"name": "CEO"
},
{
"name": "CTO"
},
{
"name": "Chairman"
},
{
"name": "Director"
},
{
"name": "Trustee"
},
{
"name": "Legal Counsel"
},
{
"name": "Manager"
},
{
"name": "Candidate"
}
],
"value": "Director"
},
{
"id": 1939,
"label": "First Name",
"value": "NAME 2"
},
{
"id": 1946,
"label": "Email",
"validationType": "EMAIL",
"value": "example@example.com"
}
]
}'
response = http.request(request)
puts response.body
{}
PATCH
/v1/collaborators/{collaboratorId}/rolesPATCH
Base URLstring
Target server for requests. Edit to use your own host.
Bearer Token
Bearer Tokenstring
RequiredBearer token - just enter the token, "Bearer" prefix will be added automatically
Content-Typestring
RequiredThe media type of the request body
Options: application/json
No request body parameters defined
Request Preview
Response
Response will appear here after sending the request
Authentication
header
Authorizationstring
RequiredBearer token. Authentication token required.
Path Parameters
Body
application/json
dataobject
RequiredRaw application/json data
Responses
Successful response
Was this page helpful?