Start on call mobile
curl --request POST \
--url https://api.sortx.co.uk/maintenance-pro/on-call/mobile \
--header 'Content-Type: application/json' \
--header 'x-api-key: <api-key>' \
--data '
{
"mobile": "<string>"
}
'const options = {
method: 'POST',
headers: {'x-api-key': '<api-key>', 'Content-Type': 'application/json'},
body: JSON.stringify({mobile: '<string>'})
};
fetch('https://api.sortx.co.uk/maintenance-pro/on-call/mobile', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));import requests
url = "https://api.sortx.co.uk/maintenance-pro/on-call/mobile"
payload = { "mobile": "<string>" }
headers = {
"x-api-key": "<api-key>",
"Content-Type": "application/json"
}
response = requests.post(url, json=payload, headers=headers)
print(response.text){
"settings": {
"enabled": true,
"ackMinutes": 0,
"officeHours": {
"mon": {
"open": "<string>",
"close": "<string>"
},
"tue": {
"open": "<string>",
"close": "<string>"
},
"wed": {
"open": "<string>",
"close": "<string>"
},
"thu": {
"open": "<string>",
"close": "<string>"
},
"fri": {
"open": "<string>",
"close": "<string>"
},
"sat": {
"open": "<string>",
"close": "<string>"
},
"sun": {
"open": "<string>",
"close": "<string>"
}
},
"shifts": [
{
"id": "<string>",
"userId": "<string>",
"days": [
"mon"
],
"start": "<string>",
"end": "<string>"
}
]
},
"revision": 123,
"savedAt": "<string>",
"canManage": true,
"timeZone": "<string>",
"members": [
{
"userId": "<string>",
"name": "<string>",
"email": "<string>",
"role": "<string>",
"mobile": "<string>",
"mobileVerified": true
}
],
"nowChain": [
{
"userId": "<string>",
"name": "<string>",
"reason": "rota"
}
],
"outOfHoursNow": true,
"me": {
"userId": "<string>",
"mobile": "<string>",
"verified": true,
"pendingMobile": "<string>"
}
}{
"_tag": "TenantCreateRejected",
"reason": "<string>",
"field": "<string>"
}{
"_tag": "Unauthenticated"
}{
"_tag": "TenantSuspended",
"tenantId": "<string>",
"reason": "<string>"
}{
"_tag": "EntitlementMissing",
"tenantId": "<string>",
"moduleId": "<string>"
}{
"_tag": "TenantNotFound",
"slug": "<string>"
}{
"_tag": "WebhookDuplicate",
"integration": "<string>",
"externalId": "<string>"
}{
"_tag": "RateLimited",
"key": "<string>",
"retryAfterSeconds": 123,
"message": "<string>"
}{
"_tag": "IntegrationUnavailable",
"integration": "<string>",
"detail": "<string>"
}maintenance-pro
Start on call mobile
Text a code to the signed-in person’s mobile for emergency texts
POST
/
maintenance-pro
/
on-call
/
mobile
Start on call mobile
curl --request POST \
--url https://api.sortx.co.uk/maintenance-pro/on-call/mobile \
--header 'Content-Type: application/json' \
--header 'x-api-key: <api-key>' \
--data '
{
"mobile": "<string>"
}
'const options = {
method: 'POST',
headers: {'x-api-key': '<api-key>', 'Content-Type': 'application/json'},
body: JSON.stringify({mobile: '<string>'})
};
fetch('https://api.sortx.co.uk/maintenance-pro/on-call/mobile', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));import requests
url = "https://api.sortx.co.uk/maintenance-pro/on-call/mobile"
payload = { "mobile": "<string>" }
headers = {
"x-api-key": "<api-key>",
"Content-Type": "application/json"
}
response = requests.post(url, json=payload, headers=headers)
print(response.text){
"settings": {
"enabled": true,
"ackMinutes": 0,
"officeHours": {
"mon": {
"open": "<string>",
"close": "<string>"
},
"tue": {
"open": "<string>",
"close": "<string>"
},
"wed": {
"open": "<string>",
"close": "<string>"
},
"thu": {
"open": "<string>",
"close": "<string>"
},
"fri": {
"open": "<string>",
"close": "<string>"
},
"sat": {
"open": "<string>",
"close": "<string>"
},
"sun": {
"open": "<string>",
"close": "<string>"
}
},
"shifts": [
{
"id": "<string>",
"userId": "<string>",
"days": [
"mon"
],
"start": "<string>",
"end": "<string>"
}
]
},
"revision": 123,
"savedAt": "<string>",
"canManage": true,
"timeZone": "<string>",
"members": [
{
"userId": "<string>",
"name": "<string>",
"email": "<string>",
"role": "<string>",
"mobile": "<string>",
"mobileVerified": true
}
],
"nowChain": [
{
"userId": "<string>",
"name": "<string>",
"reason": "rota"
}
],
"outOfHoursNow": true,
"me": {
"userId": "<string>",
"mobile": "<string>",
"verified": true,
"pendingMobile": "<string>"
}
}{
"_tag": "TenantCreateRejected",
"reason": "<string>",
"field": "<string>"
}{
"_tag": "Unauthenticated"
}{
"_tag": "TenantSuspended",
"tenantId": "<string>",
"reason": "<string>"
}{
"_tag": "EntitlementMissing",
"tenantId": "<string>",
"moduleId": "<string>"
}{
"_tag": "TenantNotFound",
"slug": "<string>"
}{
"_tag": "WebhookDuplicate",
"integration": "<string>",
"externalId": "<string>"
}{
"_tag": "RateLimited",
"key": "<string>",
"retryAfterSeconds": 123,
"message": "<string>"
}{
"_tag": "IntegrationUnavailable",
"integration": "<string>",
"detail": "<string>"
}Authorizations
A workspace API key (Settings → API keys), scoped to <group>:read / <group>:write.
Body
application/json
Maximum string length:
32Response
Success
Show child attributes
Show child attributes
Show child attributes
Show child attributes
Show child attributes
Show child attributes
Show child attributes
Show child attributes