Sending SMS - messageID doesn't correspond to a valid SMS uuid

General
1

Hi guys.

Not sure if this is a bug or not, but when I successfully send an SMS using the /platform_service_sms path, the messageID field in the reponse isn’t the uuid of the newly created SMS.

For instance, the following request:

{
  "to": "<mobilenumber>",
  "message": "Test message to check API",
  "regardingJobUUID": "<uuid>"
}

Returns this response:

{
"errorCode": 0,
"message": "OK",
"messageID": "1fca2d41-7746-4b2c-a88a-24432fd9e82b",
"submittedAt": "2026-06-02T01:46:23+00:00",
"to": "<mobilenmber>"
}

But when listing the SMSs, the record has a different uuid:

{
  “uuid”: “85e51507-8395-497d-ba70-2443239557ab”,
  “related_object”: “job”,
  “related_object_uuid”: “<uuid>”,
  “timestamp”: “2026-06-02 11:46:24”,
  “direction”: “outbound”,
  “sent_by_staff_uuid”: “<uuid>”,
  “to_phone”: “<mobilenumber>”,
  “from_phone”: null,
  “message”: “Test message to check API”
}

If it’s not a bug, is it possible to get the x-record-uuid header field to return the uuid of the created sms, like other Create actions in the API?

Cheers :slight_smile:

2

Hi Chris,

In the Messaging API, the messageID returned from /platform_service_sms is a unique reference number for the message that was sent (the docs even show an example like ABC1234), so it isn’t documented as the UUID of an SMS record.

If you include regardingJobUUID, ServiceM8 uses that to link the message to the job so it appears in the job diary.

The x-record-uuid header is documented for standard record-creation endpoints (for example /note.json and /jobactivity.json), but the Messaging API send endpoint is write-only and the SMS conversation entries in the job diary aren’t exposed through the public REST API, so there isn’t currently a supported way to have the send call return a job-diary SMS UUID via x-record-uuid.

If you email support@servicem8.com with a redacted example (messageID, submittedAt, and the job UUID), we can confirm what you’re seeing and log the request.

Thanks,
Cody