Toggle SMS Notifications
Allow clients to enable or disable SMS notifications for a specific job or for all their future jobs via an API key.
Purpose: Provides end clients with control over their SMS notification preferences directly from your integrated platform, using their secure review_key
for authentication.
Endpoint
Updates the SMS notification setting (do_notify_sms
) either for a specific job or for the client's overall profile.
Authentification
This endpoint requires authentification via a custom API key header.
The API key used must have the "Allow Public Track" permission enabled in the Logis settings.
Request Body
The endpoint expects a JSON payload in the request body specifying the job, verification key, the desired notification state, and whether to update the job or the client profile:
Fields
Field | Type | Required | Description |
---|---|---|---|
job_id | string | Yes | The UUID of a job associated with the client whose preference is being changed. Used with review_key to authenticate the client. |
review_key | string | Yes | The unique UUID review key associated with the specified job_id , used for client verification. |
do_notify_sms | string | Yes | The desired SMS notification state. Must be sent as the string "true" or "false" . |
update_target | string | Yes | Specifies what to update. Must be either "job" (to change setting for this job only) or "client" (to change default preference). |
The review_key
acts as a secure token to verify that the request likely originates from the intended recipient (or a system acting on their behalf). This
key is usually sent to the client via SMS or email through Logis' notification system (e.g., in the public tracking link). You can retrieve the review_key
for a specific job using the Fetch Job Track endpoint.
Success Response
On successful update, the endpoint returns a 200 OK
status code. The response body contains
either the updated job
object or the updated end_client
object, depending on the update_target
.
Response for update_target
: "job"
Response for update_target
: "client"
Error Responses
Status Code | Error Code / Reason | Description |
---|---|---|
400 Bad Request | Missing Required Fields | job_id , review_key , do_notify_sms , or update_target was missing. |
400 Bad Request | Invalid review_key format | The provided review_key was not a valid UUID format. |
400 Bad Request | Invalid update_target | The update_target value was something other than "job" or "client" . |
401 Unauthorized | Missing LOGIS-API-KEY header | The required API key header was not included. |
401 Unauthorized | Incorrect review_key | The review_key provided does not match the one associated with the job_id . |
403 Forbidden | Invalid/Inactive LOGIS-API-KEY | The provided API key is not valid or is inactive. |
403 Forbidden | Permission Denied (allow_public_track) | The API key used does not have the required permission (public track permission enables this toggle). |
404 Not Found | Job Not Found | No job exists with the provided job_id . |
429 Too Many Requests | Rate Limit Exceeded (Key or Global) | The API key's hourly limit or the user's global daily limit was exceeded. |