CollaboratorsUpdate collaborator roles

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"
    }
  ]
}'
{}
PATCH
/v1/collaborators/{collaboratorId}/roles
PATCH
Base URLstring

Target server for requests. Edit to use your own host.

Bearer Token
Bearer Tokenstring
Required

Bearer token - just enter the token, "Bearer" prefix will be added automatically

Content-Typestring
Required

The 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
Required

Bearer token. Authentication token required.

Path Parameters

Body

application/json
dataobject
Required

Raw application/json data

Responses

Successful response