PUT

Update a sales channel

Scope: sales:sales-channels.write https://api.alladdin.com/api/v2/sales-channels/{salesChannelId}

Updates an existing sales channel. You can change the name, color, and account number.
Updating a sales channel does not affect documents or contacts that already reference it.

Parameters

Path parameters

salesChannelId string required

Sales Channel ID (24-char hex ObjectId)

Request body

object name string

Display name for the sales channel

color string | null

Hex color code for UI display

Request

python

import requests

url = "https://api.alladdin.com/api/v2/sales-channels/{salesChannelId}"
headers = {
    "Authorization": "Bearer YOUR_API_KEY",
    "Accept": "application/json",
}

payload = {
    "name": "string",
    "color": "#FF5733"
}
response = requests.put(url, headers=headers, json=payload)
print(response.json())

Responses

Response

json

{
  "id": "string"
}

Success responses

200 Sales channel updated application/json object id string

Error responses

400 Bad request application/json 401 Invalid or missing API key application/json 403 Insufficient permissions application/json 404 Sales channel not found application/json 422 Validation error application/json

← PreviousCreate a sales channel →

Next →List all sales channels →

Alladdin