Update Integration Auth

curl --request PATCH \
  --url https://api.sigmamind.ai/v1/integrations/{integrationId}/auth/{authId} \
  --header 'Content-Type: application/json' \
  --header 'X-API-Key: <api-key>' \
  --data '
{
  "token": "eyJhbGciOiJSUzI1NiIsInR5cCI6IkpXVCJ9...updated",
  "username": "new_api_user@example.com",
  "password": "newS3cretP@ssword",
  "apiKey": {
    "key": "X-API-KEY",
    "value": "<secret>",
    "position": "header"
  },
  "headers": [
    [
      {
        "key": "Content-Type",
        "value": "application/json"
      }
    ]
  ]
}
'

import requests

url = "https://api.sigmamind.ai/v1/integrations/{integrationId}/auth/{authId}"

payload = {
    "token": "eyJhbGciOiJSUzI1NiIsInR5cCI6IkpXVCJ9...updated",
    "username": "new_api_user@example.com",
    "password": "newS3cretP@ssword",
    "apiKey": {
        "key": "X-API-KEY",
        "value": "<secret>",
        "position": "header"
    },
    "headers": [[
            {
                "key": "Content-Type",
                "value": "application/json"
            }
        ]]
}
headers = {
    "X-API-Key": "<api-key>",
    "Content-Type": "application/json"
}

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

print(response.text)

const options = {
  method: 'PATCH',
  headers: {'X-API-Key': '<api-key>', 'Content-Type': 'application/json'},
  body: JSON.stringify({
    token: 'eyJhbGciOiJSUzI1NiIsInR5cCI6IkpXVCJ9...updated',
    username: 'new_api_user@example.com',
    password: 'newS3cretP@ssword',
    apiKey: {key: 'X-API-KEY', value: '<secret>', position: 'header'},
    headers: [[{key: 'Content-Type', value: 'application/json'}]]
  })
};

fetch('https://api.sigmamind.ai/v1/integrations/{integrationId}/auth/{authId}', 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.sigmamind.ai/v1/integrations/{integrationId}/auth/{authId}",
  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([
    'token' => 'eyJhbGciOiJSUzI1NiIsInR5cCI6IkpXVCJ9...updated',
    'username' => 'new_api_user@example.com',
    'password' => 'newS3cretP@ssword',
    'apiKey' => [
        'key' => 'X-API-KEY',
        'value' => '<secret>',
        'position' => 'header'
    ],
    'headers' => [
        [
                [
                                'key' => 'Content-Type',
                                'value' => 'application/json'
                ]
        ]
    ]
  ]),
  CURLOPT_HTTPHEADER => [
    "Content-Type: application/json",
    "X-API-Key: <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.sigmamind.ai/v1/integrations/{integrationId}/auth/{authId}"

	payload := strings.NewReader("{\n  \"token\": \"eyJhbGciOiJSUzI1NiIsInR5cCI6IkpXVCJ9...updated\",\n  \"username\": \"new_api_user@example.com\",\n  \"password\": \"newS3cretP@ssword\",\n  \"apiKey\": {\n    \"key\": \"X-API-KEY\",\n    \"value\": \"<secret>\",\n    \"position\": \"header\"\n  },\n  \"headers\": [\n    [\n      {\n        \"key\": \"Content-Type\",\n        \"value\": \"application/json\"\n      }\n    ]\n  ]\n}")

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

	req.Header.Add("X-API-Key", "<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.sigmamind.ai/v1/integrations/{integrationId}/auth/{authId}")
  .header("X-API-Key", "<api-key>")
  .header("Content-Type", "application/json")
  .body("{\n  \"token\": \"eyJhbGciOiJSUzI1NiIsInR5cCI6IkpXVCJ9...updated\",\n  \"username\": \"new_api_user@example.com\",\n  \"password\": \"newS3cretP@ssword\",\n  \"apiKey\": {\n    \"key\": \"X-API-KEY\",\n    \"value\": \"<secret>\",\n    \"position\": \"header\"\n  },\n  \"headers\": [\n    [\n      {\n        \"key\": \"Content-Type\",\n        \"value\": \"application/json\"\n      }\n    ]\n  ]\n}")
  .asString();

require 'uri'
require 'net/http'

url = URI("https://api.sigmamind.ai/v1/integrations/{integrationId}/auth/{authId}")

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

request = Net::HTTP::Patch.new(url)
request["X-API-Key"] = '<api-key>'
request["Content-Type"] = 'application/json'
request.body = "{\n  \"token\": \"eyJhbGciOiJSUzI1NiIsInR5cCI6IkpXVCJ9...updated\",\n  \"username\": \"new_api_user@example.com\",\n  \"password\": \"newS3cretP@ssword\",\n  \"apiKey\": {\n    \"key\": \"X-API-KEY\",\n    \"value\": \"<secret>\",\n    \"position\": \"header\"\n  },\n  \"headers\": [\n    [\n      {\n        \"key\": \"Content-Type\",\n        \"value\": \"application/json\"\n      }\n    ]\n  ]\n}"

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

{
  "authId": "auth_P3kNz7Yv1Qm9",
  "integrationId": "intg_AuUKK371Spr5",
  "authType": "API_KEY",
  "headers": [
    {
      "key": "X-Request-Source",
      "value": "sigmamind"
    }
  ],
  "createdAt": "2023-11-07T05:31:56Z",
  "updatedAt": "2023-11-07T05:31:56Z"
}

{
  "error": "Bad Request",
  "message": "Invalid request parameters",
  "path": "/v1/integrations/{integrationId}/auth",
  "status": 400,
  "timestamp": "2026-05-05T10:06:45.984Z"
}

{
  "error": "Unauthorized",
  "message": "X-API-Key is missing or invalid",
  "path": "/v1/integrations/{integrationId}/auth",
  "status": 401,
  "timestamp": "2026-05-05T10:06:45.984Z"
}

{
  "error": "Forbidden",
  "message": "Access denied for this resource",
  "path": "/v1/integrations/{integrationId}/auth",
  "status": 403,
  "timestamp": "2026-05-05T10:06:45.984Z"
}

{
  "error": "Not Found",
  "message": "The requested resource was not found",
  "path": "/v1/integrations/{integrationId}/auth",
  "status": 404,
  "timestamp": "2026-05-05T10:06:45.984Z"
}

{
  "error": "Internal Server Error",
  "message": "Unexpected server error",
  "path": "/v1/integrations/{integrationId}/auth",
  "status": 500,
  "timestamp": "2026-05-05T10:06:45.984Z"
}

PATCH

integrations

{integrationId}

auth

{authId}

Update Integration Auth

curl --request PATCH \
  --url https://api.sigmamind.ai/v1/integrations/{integrationId}/auth/{authId} \
  --header 'Content-Type: application/json' \
  --header 'X-API-Key: <api-key>' \
  --data '
{
  "token": "eyJhbGciOiJSUzI1NiIsInR5cCI6IkpXVCJ9...updated",
  "username": "new_api_user@example.com",
  "password": "newS3cretP@ssword",
  "apiKey": {
    "key": "X-API-KEY",
    "value": "<secret>",
    "position": "header"
  },
  "headers": [
    [
      {
        "key": "Content-Type",
        "value": "application/json"
      }
    ]
  ]
}
'

import requests

url = "https://api.sigmamind.ai/v1/integrations/{integrationId}/auth/{authId}"

payload = {
    "token": "eyJhbGciOiJSUzI1NiIsInR5cCI6IkpXVCJ9...updated",
    "username": "new_api_user@example.com",
    "password": "newS3cretP@ssword",
    "apiKey": {
        "key": "X-API-KEY",
        "value": "<secret>",
        "position": "header"
    },
    "headers": [[
            {
                "key": "Content-Type",
                "value": "application/json"
            }
        ]]
}
headers = {
    "X-API-Key": "<api-key>",
    "Content-Type": "application/json"
}

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

print(response.text)

const options = {
  method: 'PATCH',
  headers: {'X-API-Key': '<api-key>', 'Content-Type': 'application/json'},
  body: JSON.stringify({
    token: 'eyJhbGciOiJSUzI1NiIsInR5cCI6IkpXVCJ9...updated',
    username: 'new_api_user@example.com',
    password: 'newS3cretP@ssword',
    apiKey: {key: 'X-API-KEY', value: '<secret>', position: 'header'},
    headers: [[{key: 'Content-Type', value: 'application/json'}]]
  })
};

fetch('https://api.sigmamind.ai/v1/integrations/{integrationId}/auth/{authId}', 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.sigmamind.ai/v1/integrations/{integrationId}/auth/{authId}",
  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([
    'token' => 'eyJhbGciOiJSUzI1NiIsInR5cCI6IkpXVCJ9...updated',
    'username' => 'new_api_user@example.com',
    'password' => 'newS3cretP@ssword',
    'apiKey' => [
        'key' => 'X-API-KEY',
        'value' => '<secret>',
        'position' => 'header'
    ],
    'headers' => [
        [
                [
                                'key' => 'Content-Type',
                                'value' => 'application/json'
                ]
        ]
    ]
  ]),
  CURLOPT_HTTPHEADER => [
    "Content-Type: application/json",
    "X-API-Key: <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.sigmamind.ai/v1/integrations/{integrationId}/auth/{authId}"

	payload := strings.NewReader("{\n  \"token\": \"eyJhbGciOiJSUzI1NiIsInR5cCI6IkpXVCJ9...updated\",\n  \"username\": \"new_api_user@example.com\",\n  \"password\": \"newS3cretP@ssword\",\n  \"apiKey\": {\n    \"key\": \"X-API-KEY\",\n    \"value\": \"<secret>\",\n    \"position\": \"header\"\n  },\n  \"headers\": [\n    [\n      {\n        \"key\": \"Content-Type\",\n        \"value\": \"application/json\"\n      }\n    ]\n  ]\n}")

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

	req.Header.Add("X-API-Key", "<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.sigmamind.ai/v1/integrations/{integrationId}/auth/{authId}")
  .header("X-API-Key", "<api-key>")
  .header("Content-Type", "application/json")
  .body("{\n  \"token\": \"eyJhbGciOiJSUzI1NiIsInR5cCI6IkpXVCJ9...updated\",\n  \"username\": \"new_api_user@example.com\",\n  \"password\": \"newS3cretP@ssword\",\n  \"apiKey\": {\n    \"key\": \"X-API-KEY\",\n    \"value\": \"<secret>\",\n    \"position\": \"header\"\n  },\n  \"headers\": [\n    [\n      {\n        \"key\": \"Content-Type\",\n        \"value\": \"application/json\"\n      }\n    ]\n  ]\n}")
  .asString();

require 'uri'
require 'net/http'

url = URI("https://api.sigmamind.ai/v1/integrations/{integrationId}/auth/{authId}")

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

request = Net::HTTP::Patch.new(url)
request["X-API-Key"] = '<api-key>'
request["Content-Type"] = 'application/json'
request.body = "{\n  \"token\": \"eyJhbGciOiJSUzI1NiIsInR5cCI6IkpXVCJ9...updated\",\n  \"username\": \"new_api_user@example.com\",\n  \"password\": \"newS3cretP@ssword\",\n  \"apiKey\": {\n    \"key\": \"X-API-KEY\",\n    \"value\": \"<secret>\",\n    \"position\": \"header\"\n  },\n  \"headers\": [\n    [\n      {\n        \"key\": \"Content-Type\",\n        \"value\": \"application/json\"\n      }\n    ]\n  ]\n}"

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

{
  "authId": "auth_P3kNz7Yv1Qm9",
  "integrationId": "intg_AuUKK371Spr5",
  "authType": "API_KEY",
  "headers": [
    {
      "key": "X-Request-Source",
      "value": "sigmamind"
    }
  ],
  "createdAt": "2023-11-07T05:31:56Z",
  "updatedAt": "2023-11-07T05:31:56Z"
}

{
  "error": "Bad Request",
  "message": "Invalid request parameters",
  "path": "/v1/integrations/{integrationId}/auth",
  "status": 400,
  "timestamp": "2026-05-05T10:06:45.984Z"
}

{
  "error": "Unauthorized",
  "message": "X-API-Key is missing or invalid",
  "path": "/v1/integrations/{integrationId}/auth",
  "status": 401,
  "timestamp": "2026-05-05T10:06:45.984Z"
}

{
  "error": "Forbidden",
  "message": "Access denied for this resource",
  "path": "/v1/integrations/{integrationId}/auth",
  "status": 403,
  "timestamp": "2026-05-05T10:06:45.984Z"
}

{
  "error": "Not Found",
  "message": "The requested resource was not found",
  "path": "/v1/integrations/{integrationId}/auth",
  "status": 404,
  "timestamp": "2026-05-05T10:06:45.984Z"
}

{
  "error": "Internal Server Error",
  "message": "Unexpected server error",
  "path": "/v1/integrations/{integrationId}/auth",
  "status": 500,
  "timestamp": "2026-05-05T10:06:45.984Z"
}

Authorizations

X-API-Key

string

header

required

Authenticate every request by passing your API key in the X-API-Key header. To get your key, go to Dashboard → API Keys and create or copy your Production API key.

Path Parameters

integrationId

string

required

Unique identifier for the integration

authId

string

required

Unique identifier for the auth record

Body

application/json

Request body to partially update an existing authentication credential record. Only fields included in the request body are updated — omitted fields are left unchanged. The authType set at creation time is permanent and cannot be changed via this endpoint. Provide only the credential fields that match the original authType.

token

string

Replacement bearer token. Applicable only when the auth record was originally created with authType BEARER_TOKEN. Overwrites the previously stored token. The system will use this new value on all subsequent outbound requests. Omit this field to leave the existing token unchanged.

Example:

"eyJhbGciOiJSUzI1NiIsInR5cCI6IkpXVCJ9...updated"

username

string

Replacement username for Basic authentication. Applicable only when the auth record was originally created with authType BASIC_AUTH. Can be updated independently — omitting this field leaves the existing username unchanged.

Maximum string length: 256

Example:

"new_api_user@example.com"

password

string

Replacement password for Basic authentication. Applicable only when the auth record was originally created with authType BASIC_AUTH. Can be updated independently — omitting this field leaves the existing password unchanged.

Maximum string length: 512

Example:

"newS3cretP@ssword"

apiKey

object

Defines how an API key is attached to outgoing requests. Use this when the API requires a key in headers or query parameters.

Show child attributes

Example:

{
  "key": "X-API-KEY",
  "value": "<secret>",
  "position": "header"
}

headers

object[]

Replacement list of static headers attached to every outbound request for this auth record. Pass a non-empty list to overwrite all existing headers with the new set. Pass an empty list [] to remove all headers. Omit this field entirely to leave existing headers unchanged.

Show child attributes

Response

authId

string

Unique identifier for the auth record

Example:

"auth_P3kNz7Yv1Qm9"

integrationId

string

Unique identifier of the parent integration

Example:

"intg_AuUKK371Spr5"

authType

enum<string>

The authentication strategy this credential set uses. Determines which credential fields are required: API_KEY — provide the apiKey object (key name, secret value, and position). BEARER_TOKEN — provide the token field. BASIC_AUTH — provide username and password fields. NO_AUTH — no credential fields required.

Available options:

NO_AUTH,

BASIC_AUTH,

BEARER_TOKEN,

API_KEY

Example:

"API_KEY"

headers

object

Optional list of static HTTP headers attached to every outbound request under this auth. Applied on top of any headers defined at the integration or tool level. Useful for fixed metadata headers required by the third-party API.

Example:

[
  {
    "key": "X-Request-Source",
    "value": "sigmamind"
  }
]

createdAt

string<date-time>

Timestamp when the record was created

updatedAt

string<date-time>

Timestamp when the record was last updated

Calls

Chats

Phone Numbers

Single Prompt Agents

Conversational Agents

Campaigns

Integrations

Integration Auth

Integration Tools

Mock Tool Data

Test Cases

Batch

Test Runs

Webhooks

QA Rules

QA Issues

Knowledge bases

Update Integration Auth

Authorizations

Path Parameters

Body

Response