Skip to content

Update Draft

  • Endpoint Path: /api/fresns/v1/editor/{type}/draft/{did}
  • Method: PATCH
  • Request: Rest + application/json

Headers Optional Parameter

KeyPublic Mode (Required)Private Mode (Required)
X-Fresns-Aidrequiredrequired
X-Fresns-Aid-Tokenrequiredrequired
X-Fresns-Uidrequiredrequired
X-Fresns-Uid-Tokenrequiredrequired

Path Variables

KeyTypeRequiredDescription
typeStringrequiredpost or comment
didStringrequiredDraft ID

Body Params

KeyTypeRequiredDescription
editorFskeyStringoptionalIs it a plugin editor, empty means no
quotePidStringoptionalPost-Only: Quoted Post ID
gidStringoptionalPost-Only: Group
titleStringoptionalPost-Only: Title
contentStringoptionalContent
Insert the file in the content in the format [file:{fid}]
isMarkdownBooleanoptionalContent in MD format
isAnonymousBooleanoptionalAnonymous
commentPolicyNumberoptionalPost-Only: Who can comment?
1 Everyone 2 People you follow 3 People you follow or verified 4 No one is allowed 5 Only users you mention
commentPrivateBooleanoptionalPost Are all comments private
Comment Is this comment private
Private is only visible to the author of the comment and the author of the post.
gtidStringoptionalGeotag ID
locationInfoObjectoptionalLocation Info
fileInfoArrayoptionalFile Info
archivesArrayoptionalArchive Parameter
extendsArrayoptionalExtend Content
deleteLocationBooleanoptionalDelete locationInfo
deleteArchiveStringoptionalDelete archive parameter, pass code as parameter
deleteExtendStringoptionalDelete extend content, pass eid as parameter
deleteFileStringoptionalDelete file, pass fid as parameter

Request Description

  • For file functionality, use the File Upload Interface to upload files.
  • When published, the location information locationInfo is not used, even if it has a gtid value.

Example Parameters

json
{
    "langTag": "en", // What language this location text is in, if no value then use X-Fresns-Client-Lang-Tag
    "name": "Cupertino Library", // required
    "description": "",
    "placeId": "TRDucfBPkhuzzR9a7", // Reference: Google Map
    "placeType": "building", // Reference: Google Map
    "mapId": 2, // required 
    "latitude": 37.3185039, // required 
    "longitude": -122.0288017, // required
    "continent": "North America",
    "continentCode": "NA",
    "country": "United States",
    "countryCode": "US",
    "region": "California",
    "regionCode": "CA",
    "city": "Santa Clara",
    "cityCode": "SC",
    "district": "Cupertino",
    "address": "10800 Torre Ave, Cupertino, CA 95014",
    "zip": "95014",
    "moreInfo": {}
}
json
[
    {
        "fid": "fid",
        "sortOrder": 9,
        "moreInfo": {} // Replace with parameter (null value are replaced with null), no parameter are changed
    }
]
json
[
    {
        "code": "code",
        "value": "value",
        "isPrivate": false, // Private or not (public display or not)
        "fskey": null
    }
]
json
[
    {
        "eid": "eid",
        "canDelete": true, // Can user delete
        "sortOrder": 9,
        "fskey": null
    }
]

Return

json
{
    "code": 0,
    "message": "ok",
    "data": null
}

Released under the Apache-2.0 License