Skip to main content

Update Contact Settings

Updates the current contact settings of the platform.

HTTP Request

PATCH/api/settings/contacts

Authorization

Authorization

  • Required: Yes
  • Permission: Staff or Admin
  • Authentication: Token authentication

Request Body

FieldTypeRequiredDescription
contacts_default_consultationContactObjectNoDefault consultation support configuration (JSON, default: {})
contacts_default_questionQuestionObjectNoDefault question support configuration (JSON, default: {})

ContactObject Structure

FieldTypeRequiredDescription
emailStringNoConsultation support email address
messageStringNoConsultation support message template
subjectStringNoConsultation support subject line
mobile_numberStringNoConsultation support phone number
first_nameStringNoConsultation support first name
last_nameStringNoConsultation support last name

QuestionObject Structure

FieldTypeRequiredDescription
emailStringNoQuestion support email address
messageStringNoQuestion support message template
subjectStringNoQuestion support subject line
mobile_numberStringNoQuestion support phone number
first_nameStringNoQuestion support first name
last_nameStringNoQuestion support last name

Example Requests

1import requests
2
3# Update contact settings
4response = requests.patch('http://www.example.com/api/settings/contacts', 
5  headers={'Authorization': 'Token <your_api_key>'},
6  json={
7      "contacts_default_consultation": {
8          "enabled": true,
9          "email": "support@example.com"
10      },
11      "contacts_default_question": {
12          "enabled": true,
13          "email": "support@example.com"
14      }
15  }
16)
17print(response.json())

Status Codes

CodeDescription
200Request logs retrieved successfully
400Bad request — invalid query parameters
401Unauthorized — authentication required
403Forbidden — insufficient permissions
500Internal server error

Response Fields

FieldTypeDescription
ContactObjectDefault consultation support configuration (JSON, default: {})
QuestionObjectDefault question support configuration (JSON, default: {})

ContactObject Structure

FieldTypeDescription
emailStringConsultation support email address
messageStringConsultation support message template
subjectStringConsultation support subject line
mobile_numberStringConsultation support phone number
first_nameStringConsultation support first name
last_nameStringConsultation support last name

QuestionObject Structure

FieldTypeDescription
emailStringQuestion support email address
messageStringQuestion support message template
subjectStringQuestion support subject line
mobile_numberStringQuestion support phone number
first_nameStringQuestion support first name
last_nameStringQuestion support last name