Get all predefined messages (manager)

GET /manager/predefined-messages

Query parameters

page integer

page number
per_page integer

number of items per page
sort string

example :to sort the predefined message by id, position or active (-id_predefined_message: descending, id_predefined_message: ascending)

Values are id_predefined_message, position, or active.
filter[predefined_message_search] string

retrieve predefined message by content.

Responses

200 application/json

returns all ambassadors (paginated)
Hide response attributes Show response attributes object
- current_page integer(int32)
- data array[object]
  
  Hide data attributes Show data attributes object
  
  id_predefined_message integer
  
  contents array[object]
  
  Hide contents attributes Show contents attributes object
  
  id_i18n_content integer
  
  lang string
  
  Values are en_GB, fr_FR, es_ES, or de_DE.
  
  content string
  
  position integer
  
  active boolean
- first_page_url string
- from integer(int32)
- last_page integer(int32)
- last_page_url string
- links array[object]
  
  Hide links attributes Show links attributes object
  
  url string(nullable)
  
  label string
  
  active boolean
- next_page_url string
- path string
- per_page integer(int32)
- prev_page_url string(nullable)
- to integer(int32)
- total integer(int32)
401 application/json

Unauthorized.
Hide response attribute Show response attribute object
- message string
403

Forbidden - You don't have permission to access this route
422 application/json

Unprocessable Content
Hide response attributes Show response attributes object
- message string
  
  Error message.
- errors object
  
  Hide errors attributes Show errors attributes object
  
  field array[string]
  
  Error message details.
  
  * array[string] Additional properties
  
  Error message details.

GET /manager/predefined-messages

curl \
 -X GET https://domain.tld/api/v2/manager/predefined-messages

Response examples (200)

{
  "current_page": 42,
  "data": [
    {
      "id_predefined_message": 1,
      "contents": [
        {
          "id_i18n_content": 42,
          "lang": "en_GB",
          "content": "Hello"
        }
      ],
      "position": 1,
      "active": true
    }
  ],
  "first_page_url": "string",
  "from": 42,
  "last_page": 42,
  "last_page_url": "string",
  "links": [
    {
      "url": "string",
      "label": "string",
      "active": true
    }
  ],
  "next_page_url": "string",
  "path": "string",
  "per_page": 42,
  "prev_page_url": "string",
  "to": 42,
  "total": 42
}

Response examples (401)

{
  "message": "Unauthorized."
}

Response examples (422)

{
  "message": "field is required! (and 3 more error)",
  "errors": {
    "field": [
      "Error message details here"
    ],
    "additionalProperty1": [
      "Error message details here"
    ],
    "additionalProperty2": [
      "Error message details here"
    ]
  }
}