Skip to main content

Update Distributor

Update an existing distributor.

Endpoint: PUT /api/v1/integration/distributors/{id}

Authentication: Required (Bearer token)

Required Headers:

Authorization: Bearer <access_token>
X-Target-Server: integration

Path Parameters

ParameterTypeRequiredDescription
idstring (UUID)YesDistributor ID

Request Body

All fields are optional. Only include the fields you want to update. The meta field is optional - you can update it, remove it, or leave it unchanged.

Update with Meta:

{
"meta": {
"host": "https://example.com222",
"path": "/webhook",
"method": 1,
"authentication": {
"type": 1,
"username": "user",
"password": "pass"
}
}
}

Remove Meta (set to null):

{
"meta": null
}

Request Parameters

FieldTypeRequiredDescription
metaobject | nullNoWebhook configuration (optional, set to null to remove)
meta.hoststringNoWebhook host URL
meta.pathstringNoWebhook path
meta.methodintegerNoHTTP method (1=GET, 2=POST, etc.)
meta.authenticationobjectNoAuthentication configuration
meta.authentication.typeintegerNoAuthentication type (1=Basic, 2=Token)
meta.authentication.usernamestringNoUsername (required if type=1)
meta.authentication.passwordstringNoPassword (required if type=1)

Response

Status: 200 OK

Returns the updated distributor object.

{
"id": "39e8003c-6342-4fd3-97a1-3f2a7b437d0a",
"node_id": "e40efce4-38a3-46c4-a202-e8db95d0409c",
"meta": {
"host": "https://example.com222",
"path": "/webhook",
"method": "GET",
"authentication": {
"type": 1,
"username": "user",
"password": "pass"
}
},
"created_at": "2025-12-23T23:16:10.419732Z",
"updated_at": "2025-12-23T23:16:10.419732Z"
}

Example cURL Request

curl -X PUT 'https://<base-url>/api/v1/integration/distributors/39e8003c-6342-4fd3-97a1-3f2a7b437d0a' \
-H "Content-Type: application/json" \
-H "X-Target-Server: integration" \
-H "Authorization: Bearer <access_token>" \
-d '{
"meta": {
"host": "https://example.com222",
"path": "/webhook",
"method": 1,
"authentication": {
"type": 1,
"username": "user",
"password": "pass"
}
}
}'