For the complete documentation index, see llms.txt. This page is also available as Markdown.

Create a contact us subject

Creates a contact us subject. text and is_order_needed are required.

text is stored in the request language (see Translations and IGNORE_ACCEPT_LANGUAGE_HEADER in the section description).

post
/contact-us-subjects/
Authorizations
AuthorizationstringRequired

Token credential sent in the Authorization header, in the form: Token <your-token>. Requires a staff (admin) account.

Body

Request body for creating a contact us subject. text and is_order_needed are required.

textstring · min: 1 · max: 60Required

The subject label, written in the request language (see Translations in the section description).

Example: Order Status
is_order_neededbooleanRequired

Whether the storefront contact form requires an order to be selected for this subject.

Example: true
recipientsstring · email[] · min: 1 · nullableOptional

The addresses messages sent with this subject are e-mailed to. Send null to use CONTACT_US_EMAIL_TO instead; an empty list is rejected with 400.

Example: ["support@example.com"]
Responses
201

The created contact us subject.

application/json

A contact us subject offered on the storefront contact form.

pkintegerRead-onlyOptional

The unique identifier of the subject.

Example: 1
textstring · max: 60Optional

The subject label, in the request language (falls back to the default language when no translation exists).

Example: Order Status
is_order_neededbooleanOptional

Whether the storefront contact form requires an order to be selected for this subject.

Example: true
recipientsstring · email[] · nullableOptional

The addresses messages sent with this subject are e-mailed to. When null, the storefront uses CONTACT_US_EMAIL_TO.

Example: ["support@example.com"]
post/contact-us-subjects/
POST /api/v1/remote/1/contact-us-subjects/ HTTP/1.1
Host: sandbox.akinon.com
Authorization: YOUR_API_KEY
Content-Type: application/json
Accept: */*
Content-Length: 83

{
  "text": "Order Status",
  "is_order_needed": true,
  "recipients": [
    "support@example.com"
  ]
}
{
  "pk": 1,
  "text": "Order Status",
  "is_order_needed": true,
  "recipients": [
    "support@example.com"
  ]
}

Last updated

Was this helpful?