JobOnHold
Quick Reference
Method |
Endpoint |
Description |
|---|---|---|
GET |
/api/job/{jobDisplayId}/onhold |
|
POST |
/api/job/{jobDisplayId}/onhold |
|
DELETE |
/api/job/{jobDisplayId}/onhold |
|
GET |
/api/job/{jobDisplayId}/onhold/{id} |
|
PUT |
/api/job/{jobDisplayId}/onhold/{onHoldId} |
|
PUT |
/api/job/{jobDisplayId}/onhold/{onHoldId}/resolve |
|
POST |
/api/job/{jobDisplayId}/onhold/{onHoldId}/comment |
|
GET |
/api/job/{jobDisplayId}/onhold/followupusers |
|
GET |
/api/job/{jobDisplayId}/onhold/followupuser/{contactId} |
|
PUT |
/api/job/{jobDisplayId}/onhold/{onHoldId}/dates |
GET /api/job/{jobDisplayId}/onhold
Parameters:
Path Parameters:
jobDisplayId (string, path) (required): No description available
Example Request:
from ABConnect import ABConnectAPI
# Initialize the API client
api = ABConnectAPI()
# Make the API call
response = api.raw.get(
"/api/job/{jobDisplayId}/onhold"
,
jobDisplayId="2000000"
)
# Process the response
print(response)
ab api raw get /api/job/{jobDisplayId}/onhold \
jobDisplayId=2000000
curl -X GET \
-H 'Authorization: Bearer YOUR_API_TOKEN' \
'https://api.abconnect.co/api/job/2000000/onhold'
Sample Response:
1{
2 "status": "success",
3 "data": {}
4}
POST /api/job/{jobDisplayId}/onhold
Parameters:
Path Parameters:
jobDisplayId (string, path) (required): No description available
Example Request:
from ABConnect import ABConnectAPI
# Initialize the API client
api = ABConnectAPI()
# Make the API call
response = api.raw.post(
"/api/job/{jobDisplayId}/onhold"
,
jobDisplayId="2000000"
,
data=
{
"example": "data"
}
)
# Process the response
print(response)
ab api raw post /api/job/{jobDisplayId}/onhold \
jobDisplayId=2000000
curl -X POST \
-H 'Authorization: Bearer YOUR_API_TOKEN' \
-H 'Content-Type: application/json' \
-d '{
"example": "data"
}' \
'https://api.abconnect.co/api/job/2000000/onhold'
Sample Response:
1{
2 "id": "789e0123-e89b-12d3-a456-426614174002",
3 "status": "created",
4 "message": "Resource created successfully"
5}
DELETE /api/job/{jobDisplayId}/onhold
Parameters:
Path Parameters:
jobDisplayId (string, path) (required): No description available
Example Request:
from ABConnect import ABConnectAPI
# Initialize the API client
api = ABConnectAPI()
# Make the API call
response = api.raw.delete(
"/api/job/{jobDisplayId}/onhold"
,
jobDisplayId="2000000"
)
# Process the response
print(response)
ab api raw delete /api/job/{jobDisplayId}/onhold \
jobDisplayId=2000000
curl -X DELETE \
-H 'Authorization: Bearer YOUR_API_TOKEN' \
'https://api.abconnect.co/api/job/2000000/onhold'
Sample Response:
1{
2 "status": "success",
3 "message": "Resource deleted successfully"
4}
GET /api/job/{jobDisplayId}/onhold/{id}
Parameters:
Path Parameters:
jobDisplayId (string, path) (required): No description available
id (integer, path) (required): No description available
Example Request:
from ABConnect import ABConnectAPI
# Initialize the API client
api = ABConnectAPI()
# Make the API call
response = api.raw.get(
"/api/job/{jobDisplayId}/onhold/{id}"
,
jobDisplayId=2000000
,
id=789e0123-e89b-12d3-a456-426614174002
)
# Process the response
print(response)
ab api raw get /api/job/{jobDisplayId}/onhold/{id} \
jobDisplayId=2000000 \
id=789e0123-e89b-12d3-a456-426614174002
curl -X GET \
-H 'Authorization: Bearer YOUR_API_TOKEN' \
'https://api.abconnect.co/api/job/2000000/onhold/789e0123-e89b-12d3-a456-426614174002'
Sample Response:
1{}
PUT /api/job/{jobDisplayId}/onhold/{onHoldId}
Parameters:
Path Parameters:
jobDisplayId (string, path) (required): No description available
onHoldId (integer, path) (required): No description available
Example Request:
from ABConnect import ABConnectAPI
# Initialize the API client
api = ABConnectAPI()
# Make the API call
response = api.raw.put(
"/api/job/{jobDisplayId}/onhold/{onHoldId}"
,
jobDisplayId=2000000
,
onHoldId=789e0123-e89b-12d3-a456-426614174002
,
data=
{
"example": "data"
}
)
# Process the response
print(response)
ab api raw put /api/job/{jobDisplayId}/onhold/{onHoldId} \
jobDisplayId=2000000 \
onHoldId=789e0123-e89b-12d3-a456-426614174002
curl -X PUT \
-H 'Authorization: Bearer YOUR_API_TOKEN' \
-H 'Content-Type: application/json' \
-d '{
"example": "data"
}' \
'https://api.abconnect.co/api/job/2000000/onhold/789e0123-e89b-12d3-a456-426614174002'
Sample Response:
1{
2 "id": "123e4567-e89b-12d3-a456-426614174000",
3 "status": "updated",
4 "message": "Resource updated successfully"
5}
PUT /api/job/{jobDisplayId}/onhold/{onHoldId}/resolve
Parameters:
Path Parameters:
jobDisplayId (string, path) (required): No description available
onHoldId (integer, path) (required): No description available
Example Request:
from ABConnect import ABConnectAPI
# Initialize the API client
api = ABConnectAPI()
# Make the API call
response = api.raw.put(
"/api/job/{jobDisplayId}/onhold/{onHoldId}/resolve"
,
jobDisplayId=2000000
,
onHoldId=789e0123-e89b-12d3-a456-426614174002
,
data=
{
"example": "data"
}
)
# Process the response
print(response)
ab api raw put /api/job/{jobDisplayId}/onhold/{onHoldId}/resolve \
jobDisplayId=2000000 \
onHoldId=789e0123-e89b-12d3-a456-426614174002
curl -X PUT \
-H 'Authorization: Bearer YOUR_API_TOKEN' \
-H 'Content-Type: application/json' \
-d '{
"example": "data"
}' \
'https://api.abconnect.co/api/job/2000000/onhold/789e0123-e89b-12d3-a456-426614174002/resolve'
Sample Response:
1{
2 "id": "123e4567-e89b-12d3-a456-426614174000",
3 "status": "updated",
4 "message": "Resource updated successfully"
5}
POST /api/job/{jobDisplayId}/onhold/{onHoldId}/comment
Parameters:
Path Parameters:
jobDisplayId (string, path) (required): No description available
onHoldId (integer, path) (required): No description available
Example Request:
from ABConnect import ABConnectAPI
# Initialize the API client
api = ABConnectAPI()
# Make the API call
response = api.raw.post(
"/api/job/{jobDisplayId}/onhold/{onHoldId}/comment"
,
jobDisplayId=2000000
,
onHoldId=789e0123-e89b-12d3-a456-426614174002
,
data=
{
"example": "data"
}
)
# Process the response
print(response)
ab api raw post /api/job/{jobDisplayId}/onhold/{onHoldId}/comment \
jobDisplayId=2000000 \
onHoldId=789e0123-e89b-12d3-a456-426614174002
curl -X POST \
-H 'Authorization: Bearer YOUR_API_TOKEN' \
-H 'Content-Type: application/json' \
-d '{
"example": "data"
}' \
'https://api.abconnect.co/api/job/2000000/onhold/789e0123-e89b-12d3-a456-426614174002/comment'
Sample Response:
1{
2 "id": "789e0123-e89b-12d3-a456-426614174002",
3 "status": "created",
4 "message": "Resource created successfully"
5}
GET /api/job/{jobDisplayId}/onhold/followupusers
Parameters:
Path Parameters:
jobDisplayId (string, path) (required): No description available
Example Request:
from ABConnect import ABConnectAPI
# Initialize the API client
api = ABConnectAPI()
# Make the API call
response = api.raw.get(
"/api/job/{jobDisplayId}/onhold/followupusers"
,
jobDisplayId="2000000"
)
# Process the response
print(response)
ab api raw get /api/job/{jobDisplayId}/onhold/followupusers \
jobDisplayId=2000000
curl -X GET \
-H 'Authorization: Bearer YOUR_API_TOKEN' \
'https://api.abconnect.co/api/job/2000000/onhold/followupusers'
Sample Response:
1[]
GET /api/job/{jobDisplayId}/onhold/followupuser/{contactId}
Parameters:
Path Parameters:
jobDisplayId (string, path) (required): No description available
contactId (integer, path) (required): No description available
Example Request:
from ABConnect import ABConnectAPI
# Initialize the API client
api = ABConnectAPI()
# Make the API call
response = api.raw.get(
"/api/job/{jobDisplayId}/onhold/followupuser/{contactId}"
,
jobDisplayId=2000000
,
contactId=456e7890-e89b-12d3-a456-426614174001
)
# Process the response
print(response)
ab api raw get /api/job/{jobDisplayId}/onhold/followupuser/{contactId} \
jobDisplayId=2000000 \
contactId=456e7890-e89b-12d3-a456-426614174001
curl -X GET \
-H 'Authorization: Bearer YOUR_API_TOKEN' \
'https://api.abconnect.co/api/job/2000000/onhold/followupuser/456e7890-e89b-12d3-a456-426614174001'
Sample Response:
1{
2 "status": "success",
3 "data": {}
4}
PUT /api/job/{jobDisplayId}/onhold/{onHoldId}/dates
Parameters:
Path Parameters:
jobDisplayId (string, path) (required): No description available
onHoldId (integer, path) (required): No description available
Example Request:
from ABConnect import ABConnectAPI
# Initialize the API client
api = ABConnectAPI()
# Make the API call
response = api.raw.put(
"/api/job/{jobDisplayId}/onhold/{onHoldId}/dates"
,
jobDisplayId=2000000
,
onHoldId=789e0123-e89b-12d3-a456-426614174002
,
data=
{
"example": "data"
}
)
# Process the response
print(response)
ab api raw put /api/job/{jobDisplayId}/onhold/{onHoldId}/dates \
jobDisplayId=2000000 \
onHoldId=789e0123-e89b-12d3-a456-426614174002
curl -X PUT \
-H 'Authorization: Bearer YOUR_API_TOKEN' \
-H 'Content-Type: application/json' \
-d '{
"example": "data"
}' \
'https://api.abconnect.co/api/job/2000000/onhold/789e0123-e89b-12d3-a456-426614174002/dates'
Sample Response:
1{
2 "id": "123e4567-e89b-12d3-a456-426614174000",
3 "status": "updated",
4 "message": "Resource updated successfully"
5}