update a message by id

Update a message by id

PATCH /chat/messages/{id}

Bearer token

Path parameters

id integer Required

The message id

application/json

Body

content string

Message's content.
active boolean

Message's active.

Responses

200 application/json

Return the updated message
Hide response attributes Show response attributes object
- id_message integer
- date_insert string(date-time)
- author object
  
  Additional properties are allowed.
  
  Hide author attributes Show author attributes object
  
  id_ambassador integer(int32)
  
  image string
  
  firstname string
  
  lastname string
  
  username string
  
  email string
  
  email_tmp string
  
  active integer(int32)
  
  status integer(int32)
  
  online boolean
  
  true: when last_action_date is less than 5 minutes ago
  
  last_action_date string(date-time)
  
  customer_id string
  
  anonymized boolean
- content string
- type_message integer
  
  0: text, 1: picture, 2: rating, 3: product, 4: connection, 5: request, 6: unavailable, 7: video, 8: email, 9: missed
- status_moderation integer
401 application/json

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

Forbidden - You don't have permission to access this route
404

Not found - The ambassador does not exist
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.

PATCH /chat/messages/{id}

curl \
 -X PATCH https://domain.tld/api/v2/chat/messages/{id} \
 -H "Authorization: Bearer $ACCESS_TOKEN" \
 -H "Content-Type: application/json" \
 -d '{"content":"string","active":true}'

Request examples

{
  "content": "string",
  "active": true
}

Response examples (200)

{
  "id_message": 16,
  "date_insert": "2023-10-09T12:12:40.220000Z",
  "author": {
    "id_ambassador": 42,
    "image": "string",
    "firstname": "string",
    "lastname": "string",
    "username": "string",
    "email": "string",
    "email_tmp": "string",
    "active": 42,
    "status": 42,
    "online": true,
    "last_action_date": "2024-05-04T09:42:00+00:00",
    "customer_id": "string",
    "anonymized": true
  },
  "content": "super",
  "type_message": 2,
  "status_moderation": 0
}

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"
    ]
  }
}