Favorit SMS

Favorit SMS

Get favorite SMS messages

get

Authorizations

bearerAuth

Query parameters

allbooleanOptional

Get all items without pagination

searchstringOptional

Search term for filtering items

per_pageintegerOptional

Number of items per page (default: 15)

pageintegerOptional

Page number

Responses

200

Successful operation

application/json

get

/api/workspaces/{workspaceId}/sms/messages/favorites

HTTPcURLJavaScriptPython

GET /api/workspaces/{workspaceId}/sms/messages/favorites HTTP/1.1
Host: 
Accept: */*

200

Successful operation

{
  "data": [
    {}
  ],
  "pagination": {
    "total": 1,
    "per_page": 1,
    "current_page": 1,
    "last_page": 1,
    "from": 1,
    "to": 1
  }
}

Create a new favorite SMS

post

Store a new favorite SMS for the authenticated user

Authorizations

bearerAuth

Body

application/json

textstring · max: 1024RequiredExample: This is a favorite SMS message

Responses

200

Successful operation

application/json

400

Bad request

application/json

401

Unauthenticated

post

/api/workspaces/{workspaceId}/sms/messages/favorites

HTTPcURLJavaScriptPython

POST /api/workspaces/{workspaceId}/sms/messages/favorites HTTP/1.1
Host: 
Content-Type: application/json
Accept: */*
Content-Length: 41

{
  "text": "This is a favorite SMS message"
}

{
  "success": true,
  "message": "favorit_sms",
  "data": {
    "id": 1,
    "user_id": 1,
    "text": "text",
    "created_at": "2025-12-18T06:36:32.524Z",
    "updated_at": "2025-12-18T06:36:32.524Z"
  }
}

Get a specific favorite SMS

get

Retrieve details of a specific favorite SMS message

Authorizations

bearerAuth

Path parameters

idinteger · int64Required

ID of the favorite SMS to retrieve

Responses

200

Successful operation

application/json

401

Unauthenticated

404

Favorite SMS not found

application/json

get

/api/workspaces/{workspaceId}/sms/messages/favorites/{id}

HTTPcURLJavaScriptPython

GET /api/workspaces/{workspaceId}/sms/messages/favorites/{id} HTTP/1.1
Host: 
Accept: */*

{
  "success": true,
  "message": "favorit_sms",
  "data": {
    "id": 1,
    "user_id": 1,
    "text": "text",
    "created_at": "2025-12-18T06:36:32.524Z",
    "updated_at": "2025-12-18T06:36:32.524Z"
  }
}

Update a favorite SMS

put

Authorizations

bearerAuth

Path parameters

idintegerRequired

ID of the favorite SMS to update

Body

application/json

textstring · max: 1024Optional

Responses

200

Successful operation

application/json

400

Bad request

application/json

401

Unauthenticated

404

Not Found

application/json

put

/api/workspaces/{workspaceId}/sms/messages/favorites/{id}

HTTPcURLJavaScriptPython

PUT /api/workspaces/{workspaceId}/sms/messages/favorites/{id} HTTP/1.1
Host: 
Content-Type: application/json
Accept: */*
Content-Length: 15

{
  "text": "text"
}

{
  "success": true,
  "message": "favorit_sms",
  "data": {
    "id": 1,
    "user_id": 1,
    "text": "text",
    "created_at": "2025-12-18T06:36:32.524Z",
    "updated_at": "2025-12-18T06:36:32.524Z"
  }
}

Delete a favorite SMS

delete

Deletes a specific favorite SMS by ID

Authorizations

bearerAuth

Path parameters

idintegerRequired

ID of the favorite SMS to delete

Responses

200

Successful operation

application/json

401

Unauthenticated

404

Not Found

application/json

delete

/api/workspaces/{workspaceId}/sms/messages/favorites/{id}

HTTPcURLJavaScriptPython

DELETE /api/workspaces/{workspaceId}/sms/messages/favorites/{id} HTTP/1.1
Host: 
Accept: */*

{
  "success": true,
  "message": "Favorite SMS deleted successfully"
}

Delete multiple favorite SMS messages

delete

Deletes multiple favorite SMS messages by their IDs

Authorizations

bearerAuth

Body

application/json

idsinteger[]Required

Array of favorite SMS IDs to delete

Responses

200

Successful operation

application/json

400

Bad request

application/json

401

Unauthenticated

delete

/api/workspaces/{workspaceId}/sms/messages/favorites/bulk-delete

HTTPcURLJavaScriptPython

DELETE /api/workspaces/{workspaceId}/sms/messages/favorites/bulk-delete HTTP/1.1
Host: 
Content-Type: application/json
Accept: */*
Content-Length: 11

{
  "ids": [
    1
  ]
}

{
  "success": true,
  "message": "Selected favorite SMS messages deleted successfully"
}