Save blog post

POST /api/blog/save

Api key

saves a blog post

application/json

Body Required

Request Body

permissions object

Additional properties are allowed.
Hide permissions attributes Show permissions attributes object
- view boolean
- edit boolean
- admin boolean
- delete boolean
_source object

Additional properties are allowed.
Hide _source attributes Show _source attributes object
- relatedTo string
- date string(date-time)
- created string(date-time)
- relatedID integer
- categoryID integer
- sticky integer
- importance integer
- modified string(date-time)
- id integer
- documentID integer
- document object
  
  Additional properties are allowed.
  Hide document attributes Show document attributes object
  
  fileType string
  
  shortDescription string
  
  timeSensitive boolean
  
  validFrom string(date-time)
  
  size integer
  
  id integer
  
  name string
  
  description
- comments array[object]
  Hide comments attributes Show comments attributes object
  
  CONTENT string
  
  SECURITY string
  
  COMPANY_ID integer
  
  RELATEDID integer
  
  REMINDERDATE string(date-time)
  
  TYPE_ID integer
  
  permissions object
  
  Additional properties are allowed.
  
  Hide permissions attributes Show permissions attributes object
  
  view boolean
  
  edit boolean
  
  admin boolean
  
  delete boolean
  
  CONTACTID integer
  
  CTYPE string
  
  SURNAME string
  
  FIRST_NAME string
  
  STAMP string(date-time)
  
  STATUS string
  
  RELATIONSHIPURL string
  
  ATTACHMENTS string
  
  ID integer
  
  RELATEDSUBTYPE string
  
  TITLE string
  
  RELATEDTYPE string
  
  EMAIL string(email)
- title string
- deal object
  
  Additional properties are allowed.
  Hide deal attributes Show deal attributes object
  
  period_from string(date)
  
  supplierName string
  
  supplierID intteger
  
  name string
  
  period_to string(date)
- description string

Responses

default

POST /api/blog/save

curl \
 -X POST http://api.example.com/api/blog/save \
 -H "Authorization: Bearer $ACCESS_TOKEN" \
 -H "Content-Type: application/json" \
 -d '{"permissions":{"view":true,"edit":false,"admin":false,"delete":false},"_source":{"relatedTo":"agreementt","date":"2024-05-04T09:42:00+00:00","created":"2024-05-04T09:42:00+00:00","relatedID":42,"categoryID":6,"sticky":1,"importance":4,"modified":"2024-05-04T09:42:00+00:00","id":42,"documentID":42,"document":{"fileType":"pdf","shortDescription":"string","timeSensitive":true,"validFrom":"2024-05-04T09:42:00+00:00","size":1023752,"id":42,"name":"FileName"},"comments":[{"CONTENT":"An example comment!","SECURITY":"public","COMPANY_ID":42,"RELATEDID":42,"REMINDERDATE":"2024-05-04T09:42:00+00:00","TYPE_ID":42,"permissions":{"view":true,"edit":false,"admin":false,"delete":false},"CONTACTID":42,"CTYPE":"note","SURNAME":"Bloggs","FIRST_NAME":"Joe","STAMP":"2024-05-04T09:42:00+00:00","STATUS":"open","RELATIONSHIPURL":"string","ATTACHMENTS":"string","ID":42,"RELATEDSUBTYPE":"string","TITLE":"comment title","RELATEDTYPE":"blog","EMAIL":"hello@example.com"}],"title":"Example News Heading","deal":{"period_from":"2024-05-04","supplierName":"Supplier Name","supplierID":"string","name":"Deal Name","period_to":"2024-05-04"},"description":"Example News Body"}}'

Request examples

{
  "permissions": {
    "view": true,
    "edit": false,
    "admin": false,
    "delete": false
  },
  "_source": {
    "relatedTo": "agreementt",
    "date": "2024-05-04T09:42:00+00:00",
    "created": "2024-05-04T09:42:00+00:00",
    "relatedID": 42,
    "categoryID": 6,
    "sticky": 1,
    "importance": 4,
    "modified": "2024-05-04T09:42:00+00:00",
    "id": 42,
    "documentID": 42,
    "document": {
      "fileType": "pdf",
      "shortDescription": "string",
      "timeSensitive": true,
      "validFrom": "2024-05-04T09:42:00+00:00",
      "size": 1023752,
      "id": 42,
      "name": "FileName"
    },
    "comments": [
      {
        "CONTENT": "An example comment!",
        "SECURITY": "public",
        "COMPANY_ID": 42,
        "RELATEDID": 42,
        "REMINDERDATE": "2024-05-04T09:42:00+00:00",
        "TYPE_ID": 42,
        "permissions": {
          "view": true,
          "edit": false,
          "admin": false,
          "delete": false
        },
        "CONTACTID": 42,
        "CTYPE": "note",
        "SURNAME": "Bloggs",
        "FIRST_NAME": "Joe",
        "STAMP": "2024-05-04T09:42:00+00:00",
        "STATUS": "open",
        "RELATIONSHIPURL": "string",
        "ATTACHMENTS": "string",
        "ID": 42,
        "RELATEDSUBTYPE": "string",
        "TITLE": "comment title",
        "RELATEDTYPE": "blog",
        "EMAIL": "hello@example.com"
      }
    ],
    "title": "Example News Heading",
    "deal": {
      "period_from": "2024-05-04",
      "supplierName": "Supplier Name",
      "supplierID": "string",
      "name": "Deal Name",
      "period_to": "2024-05-04"
    },
    "description": "Example News Body"
  }
}