Contact

Contact us and conversation endpoints

Submit Contact Us Form

post

Submits a contact us message.

Business Logic:

  • Email Routing: Sends an email to recipients configured in CONTACT_US_EMAIL_TO based on the operation type.

  • User Notification: Optionally sends a copy to the user if CONTACT_US_SEND_USER is enabled.

  • Reply-To: Sets the Reply-To header to the user's email if CONTACT_US_REPLY_TO_ONLY_USER is enabled.

  • CC/BCC: Applies CC/BCC rules from EMAIL_BCC_AND_CC setting.

  • Attachments: Validates and attaches files if provided.

  • Order Linking: Links the message to a specific order if required by the subject.

Dynamic Settings:

  • CONTACT_US_EMAIL_TO: Dictionary mapping operations to recipient emails.

  • CONTACT_US_SEND_USER: Boolean to enable sending a copy to the user.

  • CONTACT_US_REPLY_TO_ONLY_USER: Boolean to set user as the only Reply-To address.

  • EMAIL_BCC_AND_CC: Configuration for CC and BCC recipients.

Header parameters
X-CSRFTokenstringRequired

CSRF token for write operations (POST, PUT, PATCH, DELETE). Required for security when using session authentication. Obtain token from cookie 'csrftoken' or meta tag in HTML.

Example: abc123def456ghi789
CookiestringRequired

Session ID and CSRF token cookies. Format: sessionid=<id>; osessionid=<id>; csrftoken=<token>

Example: sessionid=abc123def456; osessionid=abc123def456; csrftoken=xyz789
Body
subjectintegerRequired

ID of the contact subject. Determines if an order reference is required.

full_namestring · max: 70Required
emailstring · emailRequired
phonestring · max: 70Optional
messagestringRequired
filestring · binaryOptional

Optional file attachment. Validated for allowed extensions and size limits.

orderintegerOptional

ID of the related order. Required if the selected subject implies an order context. Must belong to the authenticated user.

operationstring · max: 30Optional

Operation type key. Validated against configured contact email recipients (CONTACT_US_EMAIL_TO).

Responses
chevron-right
200

Message sent successfully

No content

post
/users/contact-us/

No content

List Contact Us Subjects

get

Lists available subjects for the contact us form.

Business Logic:

  • Returns subjects localized to the current language.

Responses
chevron-right
200

List of subjects

application/json
get
/users/contact-us-subjects/
200

List of subjects

List Conversations

get

Lists the user's conversations (messages).

Authorizations
sessionidstringRequired
Responses
chevron-right
200

List of conversations

application/json
get
/users/conversations/
200

List of conversations

Create Conversation

post

Creates a new conversation or message.

Authorizations
sessionidstringRequired
Header parameters
X-CSRFTokenstringRequired

CSRF token for write operations (POST, PUT, PATCH, DELETE). Required for security when using session authentication. Obtain token from cookie 'csrftoken' or meta tag in HTML.

Example: abc123def456ghi789
CookiestringRequired

Session ID and CSRF token cookies. Format: sessionid=<id>; osessionid=<id>; csrftoken=<token>

Example: sessionid=abc123def456; osessionid=abc123def456; csrftoken=xyz789
Body

Request body for creating a conversation or message.

Validation:

  • DataSource cannot reply to a review.
  • Users must match the authenticated user and content owner.
message_contentstring · max: 500Required

The body of the message.

user_typestring · enumRequired

Type of user creating the conversation.

Possible values:
content_idinteger · min: 1Required

ID of the related content object (e.g., User ID).

content_typestring · enumRequired

Slug of the content type. Determines the context of the conversation.

Possible values:
conversationintegerOptional

ID of existing conversation to reply to.

datasourceintegerOptional

ID of the datasource (if applicable).

userintegerOptional

ID of the user.

subjectstring · max: 500Optional

Subject of the conversation.

item_contentstring · enumOptional

Model name of the item content. Used to link conversation to specific items.

Possible values:
item_idintegerOptional

ID of the specific item.

conversation_typestring · enumOptional

Type of conversation.

Possible values:
is_publicbooleanOptional

Whether the conversation is public.

Responses
post
/users/conversations/

No content

Retrieve Conversation

get

Retrieves details of a specific conversation.

Authorizations
sessionidstringRequired
Path parameters
idintegerRequired

Conversation ID

Responses
chevron-right
200

Conversation details

application/json
get
/users/conversations/{id}/
200

Conversation details

Last updated

Was this helpful?