Skip to main content

Update Contact Settings

Updates the current contact settings of the project

HTTP Request

PATCH/api/settings/contacts

Authorization

Authorization

  • Required: Yes
  • Permission: Staff with ContactsSettingsPermission or Admin
  • Permission Code: 1057
  • Authentication: Token authentication

Request Body

FieldTypeRequiredDescription
contacts_default_consultationContactObjectNoDefault consultation support configuration (JSON, default: {})
contacts_default_questionQuestionObjectNoDefault 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

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())

Response Fields

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

Example Response

{
"contacts_default_consultation": {
"email": "erfan_doe@gmail.com",
"message": "I need talk to support. Please call me.",
"subject": "Consultation Support",
"last_name": "Doe10000",
"first_name": "John100000",
"mobile_number": "+1234567890"
},
"contacts_default_question": {
"email": "david_bw@gmail.com",
"message": "I have a question about product",
"subject": "Question Support",
"last_name": "David10000",
"first_name": "Bw100000",
"mobile_number": "+1234567890"
}
}