Create an issue
Create an issue
Overview
Requires a read-write API key. number is required and must be unique for the account. Other writable fields: name, release_date_actual, release_date_fuzzy, date_as_start_issue, recurring_charge_date, newsstand_ean. Date fields must be YYYY-MM-DD or null. If name is omitted, it defaults to Issue {number}.
Request parameters
No parameters.
Request body
namestringOptional public issue name. e.g. 'Spring issue'. If omitted, the issue name will be 'Issue [number]'.
release_date_actualdateActual release date. YYYY-MM-DD or null to remove.
release_date_fuzzystringTextual release date, useful if you don't know the actual date yet. Use null to remove.
date_as_start_issuedateDate this issue becomes the start issue for flexi-start subscriptions. YYYY-MM-DD or null to remove.
recurring_charge_datedateDate you want renewal charges for subscriptions that renew with this issue be made on. YYYY-MM-DD or null to remove.
newsstand_eanstringNewsstand EAN (if you sync orders to Newsstand). Use null to remove.
numbernumberRequiredIssue number. Must be unique.
Example
{
"name": "<string>",
"release_date_actual": "<date>",
"release_date_fuzzy": "<string>",
"date_as_start_issue": "<date>",
"recurring_charge_date": "<date>",
"newsstand_ean": "<string>",
"number": "<number>"
}Request examples
curl -X POST https://api.subsail.com/v1/issues/ \
-H "Authorization: Bearer YOUR_TOKEN" \
-H "Content-Type: application/json" \
-d '{
"name": "<string>",
"release_date_actual": "<date>",
"release_date_fuzzy": "<string>",
"date_as_start_issue": "<date>",
"recurring_charge_date": "<date>",
"newsstand_ean": "<string>",
"number": "<number>"
}'const response = await fetch('https://api.subsail.com/v1/issues/', {
method: 'POST',
headers: {
"Authorization": "Bearer YOUR_TOKEN",
"Content-Type": "application/json",
},
body: JSON.stringify({
"name": "<string>",
"release_date_actual": "<date>",
"release_date_fuzzy": "<string>",
"date_as_start_issue": "<date>",
"recurring_charge_date": "<date>",
"newsstand_ean": "<string>",
"number": "<number>"
}),
});
const data = await response.json();Responses
idstringIssue ID.
numbernumbernamestringrelease_date_actualdaterelease_date_fuzzystringdate_as_start_issuedaterecurring_charge_datedatenewsstand_eanstringExample
{
"id": "<string>",
"number": "<number>",
"name": "<string>",
"release_date_actual": "<date>",
"release_date_fuzzy": "<string>",
"date_as_start_issue": "<date>",
"recurring_charge_date": "<date>",
"newsstand_ean": "<string>"
}errorbooleanRequiredmessagestringRequiredcodestringMachine-readable code, e.g. read_only_key for read-only key write attempts.
Example
{
"error": "<boolean>",
"message": "<string>",
"code": "<string>"
}errorbooleanRequiredmessagestringRequiredcodestringMachine-readable code, e.g. read_only_key for read-only key write attempts.
Example
{
"error": true,
"message": "This API key is read-only. Create a read-write key in Subsail settings to perform write operations.",
"code": "read_only_key"
}