PUT

Update a contact group

Scope: contacts:contacts.write https://api.alladdin.com/api/v2/contact-groups/{contactGroupId}

Updates an existing contact group.

Parameters

Path parameters

contactGroupId string required

Contact Group ID (24-char hex ObjectId)

Request body

object name string

Group name

description string

Group description

color string

Group color (hex code)

Request

python

import requests

url = "https://api.alladdin.com/api/v2/contact-groups/{contactGroupId}"
headers = {
    "Authorization": "Bearer YOUR_API_KEY",
    "Accept": "application/json",
}

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

Responses

Response

json

{
  "id": "string"
}

Success responses

200 Contact group 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 Contact group not found application/json 429 Rate limit exceeded application/json

← PreviousCreate a contact group →

Next →List contact groups →

Alladdin