API reference › Notifications › Communication configuration

Update communication configuration

PUT /v1/settings/communication-configuration/{communication_configuration}

Scope
settings_notifications_preferences:edit
Roles
admin, scheduler

Updates an existing communication configuration

Parameters

Path parameters

NameTypeDescription
communication_configuration requiredinteger

Communication configuration ID

Example 1.

Every call also sends Authorization and X-Tenant-ID; see Getting started.

Request body required

Communication configuration data

FieldTypeDescription
name requiredstring

Configuration name

Example Shift.

value requiredstring

Configuration value

Example test@example.com.

Example

JSON
{
  "name": "Shift",
  "value": "test@example.com"
}

Example request

Shell
curl -X PUT "https://api.fetchfido.ai/v1/settings/communication-configuration/{communication_configuration}" \
  -H "Authorization: Bearer $FIDO_API_KEY" \
  -H "X-Tenant-ID: $FIDO_TENANT_ID" \
  -H "Content-Type: application/json" \
  -d '{"name":"Shift","value":"test@example.com"}'

Try it

Responses

200 Successful update

Successful update

JSON
{
  "success": true,
  "message": "Communication configuration updated successfully"
}
Response fields (2)
FieldTypeDescription
successboolean

Example true.

messagestring

Example Communication configuration updated successfully.

401 Not signed in

Missing, invalid or expired API key.

JSON
{
  "success": false,
  "message": "Invalid API key. Org and user tier keys must send an X-Tenant-ID header naming the organization the key was issued for.",
  "errors": null,
  "code": "API_KEY_MISSING"
}
Response fields (4)
FieldTypeDescription
successboolean

Example false.

messagestring

Example Invalid API key. Org and user tier keys must send an X-Tenant-ID header naming the organization the key was issued for..

errorsany or null

Null on this status.

codestring

Machine-readable reason, for branching on in client code.

One of: API_KEY_MISSING, API_KEY_INVALID, API_KEY_EXPIRED. Example API_KEY_MISSING.

403 Not allowed

Scope, tenant, IP allow-list or RBAC check failed.

JSON
{
  "success": false,
  "message": "You don't have permission to access this endpoint. This API key is missing the 'settings_notifications_preferences:edit' scope.",
  "errors": null,
  "code": ""
}
Response fields (4)
FieldTypeDescription
successboolean

Example false.

messagestring

Example You don't have permission to access this endpoint. This API key is missing the 'settings_notifications_preferences:edit' scope..

errorsany or null

Null on this status.

codestring

Always empty on this status.

Example .

429 Too many requests

Rate limit exceeded. See Retry-After.

JSON
{
  "success": false,
  "message": "You've exceeded this API key's rate limit of 120 requests per minute. Try again in 37 seconds.",
  "errors": null,
  "code": "RATE_LIMITED"
}
Response fields (4)
FieldTypeDescription
successboolean

Example false.

messagestring

Example You've exceeded this API key's rate limit of 120 requests per minute. Try again in 37 seconds..

errorsany or null

Null on this status.

codestring

Machine-readable reason, for branching on in client code.

One of: RATE_LIMITED. Example RATE_LIMITED.