JobEmail

Quick Reference

Method

Endpoint

Description

POST

/api/job/{jobDisplayId}/email/senddocument

POST

/api/job/{jobDisplayId}/email

POST

/api/job/{jobDisplayId}/email/createtransactionalemail

POST

/api/job/{jobDisplayId}/email/{emailTemplateGuid}/send

POST /api/job/{jobDisplayId}/email/senddocument

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}/email/senddocument"
,
    jobDisplayId="2000000"
,
    data=
    {
        "example": "data"
}

)

# Process the response
print(response)

Sample Response:

1{
2  "id": "789e0123-e89b-12d3-a456-426614174002",
3  "status": "created",
4  "message": "Resource created successfully"
5}

POST /api/job/{jobDisplayId}/email

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}/email"
,
    jobDisplayId="2000000"
,
    data=
    {
        "example": "data"
}

)

# Process the response
print(response)

Sample Response:

1{
2  "id": "789e0123-e89b-12d3-a456-426614174002",
3  "status": "created",
4  "message": "Resource created successfully"
5}

POST /api/job/{jobDisplayId}/email/createtransactionalemail

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}/email/createtransactionalemail"
,
    jobDisplayId="2000000"

)

# Process the response
print(response)

Sample Response:

1{
2  "id": "789e0123-e89b-12d3-a456-426614174002",
3  "status": "created",
4  "message": "Resource created successfully"
5}

POST /api/job/{jobDisplayId}/email/{emailTemplateGuid}/send

Parameters:

Path Parameters:

  • emailTemplateGuid (string, path) (required): No description available

  • 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}/email/{emailTemplateGuid}/send"
,
    emailTemplateGuid="789e0123-e89b-12d3-a456-426614174002"
,
    jobDisplayId="2000000"

)

# Process the response
print(response)

Sample Response:

1{
2  "id": "789e0123-e89b-12d3-a456-426614174002",
3  "status": "created",
4  "message": "Resource created successfully"
5}