Skip to:
Introduction
Request Template Endpoints
Request Flow
Get Request Templates
Get Template Questions
Submit Create Endpoints
Create 'Create Request'
Submit Fields
Process
Submit Review Endpoints
Create Review Request
Upload Master Document
Upload Linked Document
Upload Attachment
Populate Answers
Process
Submit Ask Legal Endpoints
Create Ask Legal Request
Upload Attachment
Populate Answers
Process
Submit Repository Endpoints
Start Submission
Upload Master Document Upload
Upload Linked Document
Upload Attachment
Process
Status Endpoints
Get Status
Update Status
Process Status Endpoints
Get Process Status
Task Endpoints
Get Task
Create Task
Update Task
Delete Task
Introduction
The domain name to access all the following endpoints is:
- UK datacentre: https://api-gateway.summize.com
- US datacentre: https://api-gateway-us.summize.com
- Swiss (CH) datacentre: https://api-gateway-ch.summize.com
- Australia (AUS) datacentre: https://api-gateway-aus.summize.com
- UAE datacentre: https://api-gateway-uae.summize.com
(If you're not sure which datacentre your tenant is in, ask your Customer Success Manager!)
Each API call requires a subscription token which can either be passed in via a query parameter or request header. Each subscription key is linked to a Summize account.
For query parameter, the parameter name is ‘subscription-key’.
For request header, the id is ‘Ocp-Apim-Subscription-Key’.
Request Template Endpoints
Request Templates for Review and Ask Legal requests are defined within the Summize Application. Information from these templates is required when an Ask Legal or Review Request is made.
Request Flow
A request operation has three phases to the API flow:
- Initial – Create a pending request
- Data – Files/Values are submitted
- Complete – The pending request is sent for processing
The multi-phase approach enables a more fluid and incremental process, thus allowing integrators more control of the flow.
Get Request Templates
Verb: GET
Endpoint: ‘api/requests/templates’
Description: Returns a list of templates used for either Create, Review or Ask Legal requests
Query Parameters:
- RequestorEmail: This must be a valid active email address registered in the Summize application
- RequestTemplateType: Valid values – 'Create', ‘Review’, ‘AskLegal’
- api-version: must be V2
Response:
200 OK: This status code is returned, along with a response body:
[
{
"Id": "4461c797-af62-4498-941f-01f7e45a80e0",
"Name": "NDA Review",
"Description": "A set of questions required for the review of an NDA"
},
{
"Id": "50d6ccd4-8353-4612-aaa2-402e35547b92",
"Name": "Services Contract",
"Description": "Use this to review any new services contracts"
}
]
Error Responses:
- 400 Bad Request: This status code is returned if any query parameters are missing or invalid.
- 401 Unauthorized: This status code is returned when an invalid Summize email address is provided.
- 500 Internal Error Server: This status code is returned when something goes wrong on our servers.
Get Template Questions
Verb: GET
Endpoint: ‘api/requests/templates/{templateId}/questions’
Description: Returns the list of questions required for a specified template id
Query Parameters:
- templateId: The template id from the Templates API call.
- RequestorEmail: This must be a valid active email address registered in the Summize application
- api-version: must be V2
Response:
200 OK: This status code is returned, along with a response body:
[
{
"Id": "5d53f477-e9d7-4c00-b09d-cc73746809a7",
"Description": "Please confirm which department this agreement will benefit or impact – IT, Marketing, HR, Operations etc.-"
},
{
"Id": "d39e73ca-fd9d-4b66-a458-0ffc7622a258",
"Description": "Please provide a description of the service or product we will be receiving, with any relevant links. "
}
]
Error Responses:
- 400 Bad Request: This status code is returned if any query parameters are missing or invalid.
- 401 Unauthorized: This status code is returned when an invalid Summize email address is provided.
- 500 Internal Error Server: This status code is returned when something goes wrong on our servers.
Submit Create Endpoints
Create 'Create Request'
Verb: POST
Endpoint: `/api/requests/create`
Description: This endpoint is the starting point for creating a new create request.
Body: It is essential to provide a properly formatted JSON payload. Please refer to the example below for guidance:
{
"templateId": "6AC27292-C034-41B9-149B-08DB4AE55336",
"requestName": "New create request",
"requestorEmail": "example@summize.com"
}
Required parameters:
- Requestor Email: This should be a valid active email address associated with Summize.
- Template Id: This should be a valid GUID representing an existing template within Summize.
- Request Name: Please specify the name for the new create request.
Optional parameters:
- Source: Please specify the request source from which you would like to set a new create request, for example, Salesforce.
Response:
- 200 OK: This status code is returned, along with a list of links, enabling you to create a new create request.
{
"base": "/api/requests/create",
"fields": "/api/requests/create/5be1e9fe-0492-45bd-a963-bdbb290c4a28/fields",
"process": "/api/requests/create/5be1e9fe-0492-45bd-a963-bdbb290c4a28/process"
}
Error Responses:
- 400 Bad Request: This status code is returned when the required parameters are missing, wrong parameter details, or an invalid JSON format is detected.
- 401 Unauthorized: This status code is returned when an invalid Summize email address is provided.
- 500 Internal Error Server: This status code is returned when something goes wrong on our servers.
Submit Fields
Verb: POST
Endpoint: `/api/requests/create/{baseRequestId}/fields`
Description: This endpoint allows you to add multiple fields that are related to their respective question IDs.
Query Parameters:
- api-version: Must be ‘V2’
- baseRequestId: the id of the request obtained from the ‘Base’ call
Body: It is essential to provide a properly formatted JSON payload. Please refer to the example below for guidance:
{
"requestorEmail": "example@summize.com",
"fields": [
{
"value": "Example account name",
"id": "Account Name"
},
{
"value": "Example company number",
"id": "Account Company Number"
},
]
}
Note: Some fields are raw string format, and some field types require stringified JSON.
- Text/Number/Date => string
- Company => JSON String ("value": "{\"companyName\":\"TechCorp\",\"companyAddress\":\"1 High Street\",\"companyId\":\"1234\"}")
- Conditional Select => JSON String ("value": "[\"EU\", \"ROW\"]")
- Guidance => id of the guidance question
Required parameters:
- Requestor Email: This should be a valid active email address associated with Summize.
- Fields: This should be a valid array containing one or more objects, structured as follows:
- Id: It needs to match the template id field.
- Type: It needs to match the template type field.
- Value: This field should not be empty.
Response:
- 200 OK: This status code is returned, along with a list of links, enabling you to create a new create request.
Error Responses:
- 400 Bad Request: This status code is returned when the required parameters are missing, wrong parameter details, or an invalid JSON format is detected.
- 401 Unauthorized: This status code is returned when an invalid Summize email address is provided.
- 404 Not Found: This status code is returned when the `{baseRequestId}` specified in the URL is not found.
- 500 Internal Error Server: This status code is returned when something goes wrong on our servers.
Process
Verb: POST
Endpoint: `/api/requests/create/{baseRequestId}/process`
Description: This endpoint serves as the final step in creating a new create request. Please note that once a successful response is received, you will no longer be able to trigger this endpoint. Additionally, the data stored for the other associated endpoints will be deleted.
Query Parameters:
- api-version: Must be ‘V2’
- baseRequestId: the id of the request obtained from the ‘Base’ call
Body: It is essential to provide a properly formatted JSON payload. Please refer to the example below for guidance:
{
"requestorEmail": "example@summize.com"
}
Required parameters:
- Requestor Email: This should be a valid active email address associated with Summize.
Response:
- 200 OK: This status code is returned, along with a status link, enabling you to check the process of the request.
Error Responses:
- 400 Bad Request: This status code is returned when the required parameters are missing, wrong parameter details, or an invalid JSON format is detected.
- 401 Unauthorized: This status code is returned when an invalid Summize email address is provided.
- 500 Internal Error Server: This status code is returned when something goes wrong on our servers.
Submit Review Endpoints
This collection of endpoints is used to submit a request for a Review. At a minimum, four calls are required:
- Base: Starts the request process
- Answers: submit the answers to the Review Request template
- Master Document Upload
- Process: Instructs the application to complete the Review request.
It is possible to include linked documents, attachments and answers to review template questions, these are all optional calls and should be made after the call to Master Document Upload.
Create Review Request
Verb: POST
Endpoint: ‘/api/requests/review’
Description: This endpoint is the starting point for creating a new review request.
Query Parameters:
- api-version: Must be ‘V2’
Body: It is essential to provide a properly formatted JSON payload. Please refer to the example below for guidance:
{
"templateId": "6AC27292-C034-41B9-149B-08DB4AE55336",
"requestName": "New review request",
"requestorEmail": "example@summize.com",
}
Required parameters:
- Requestor Email: This should be a valid active email address associated with Summize.
- Template Id: This should be a valid GUID representing an existing template within Summize (please see Template call for further details)
- Request Name: Please specify the name for the new review request.
Optional parameters:
- Source: Please specify the request source from which you would like to set a new review request, for example, Salesforce.
Response:
- 200 OK: This status code is returned, along with a list of links, enabling you to create a new review request.
{
"base": "/api/requests/review",
"masterDocument": "/api/requests/review/5be1e9fe-0492-45bd-a963-bdbb290c4a28/masterDocument",
"linkedDocument": "/api/requests/review/5be1e9fe-0492-45bd-a963-bdbb290c4a28/linkedDocument",
"attachment": "/api/requests/review/5be1e9fe-0492-45bd-a963-bdbb290c4a28/attachment",
"answers": "/api/requests/review/5be1e9fe-0492-45bd-a963-bdbb290c4a28/answers",
"process": "/api/requests/review/5be1e9fe-0492-45bd-a963-bdbb290c4a28/process"
}
Error Responses:
- 400 Bad Request: This status code is returned when the required parameters are missing, wrong parameter details, or an invalid JSON format is detected.
- 401 Unauthorized: This status code is returned when an invalid Summize email address is provided.
- 500 Internal Error Server: This status code is returned when something goes wrong on our servers.
Upload Master Document
Verb: POST
Endpoint: `/api/requests/review/{baseRequestId}/masterDocument`
Description: This endpoint is used to upload the master document. Note that there can only be one master document per review request.
Query Parameters:
- api-version: Must be ‘V2’
- baseRequestId: the id of the request obtained from the ‘Base’ call
Body: Please ensure you provide an HTTP multipart request with the following parameters:
Required parameters:
- Requestor Email: This should be a valid active email address associated with Summize.
- File: Please provide a file name with the extension, and ensure that the file type is limited to .pdf and .docx formats.
Response:
- 200 OK: This status code is returned, along with a list of links, enabling you to create a new review request.
Error Responses:
- 400 Bad Request: This status code is returned when the required parameters are missing, wrong parameter details, or an invalid multipart request format is detected.
- 401 Unauthorized: This status code is returned when an invalid Summize email address is provided.
- 404 Not Found: This status code is returned when the `{baseRequestId}` specified in the URL is not found.
- 409 Conflict: This status code is returned when there is already a master document associated with the current review request.
- 500 Internal Error Server: This status code is returned when something goes wrong on our servers.
Upload Linked Document
Verb: POST
Endpoint: `/api/requests/review/{baseRequestId}/linkedDocument`
Description: This endpoint is used to upload multiple linked documents. Please note that only one linked document can be uploaded at a time, and the file name must be unique and different from any previously uploaded linked documents.
Query Parameters:
- api-version: Must be ‘V2’
- baseRequestId: the id of the request obtained from the ‘Base’ call
Body: Please ensure you provide an HTTP multipart request with the following parameters:
Required parameters:
- Requestor Email: This should be a valid active email address associated with Summize.
- File: Please provide a file name with the extension and ensure that the file type is limited to .pdf and .docx formats.
- DocumentType: Please specify a valid document type from the following options: “Master”, “Variation”, “Addendum”, “Novation”, “SOW”, “OrderForm”.
Response:
- 200 OK: This status code is returned, along with a list of links, enabling you to create a new review request.
Error Responses:
- 400 Bad Request: This status code is returned when the required parameters are missing, wrong parameter details, or an invalid multipart request format is detected.
- 401 Unauthorized: This status code is returned when an invalid Summize email address is provided.
- 404 Not Found: This status code is returned when the `{baseRequestId}` specified in the URL is not found.
- 409 Conflict: This status code is returned when there is already a linked document with the same file name associated with the current review request.
- 500 Internal Error Server: This status code is returned when something goes wrong on our servers.
Populate Answers
Verb: POST
Endpoint: `/api/requests/review/{baseRequestId}/answers`
Description: This endpoint allows you to add multiple answers that are related to their respective question IDs.
Query Parameters:
- api-version: Must be ‘V2’
- baseRequestId: the id of the request obtained from the ‘Base’ call
Body: It is essential to provide a properly formatted JSON payload. Please refer to the example below for guidance:
{
"requestorEmail": "example@summize.com",
"questionsAnswers":[
{
"questionId": "AF979852-E2C5-4443-82D0-08DB4C792635",
"answer": "This is an example of an answer."
},
{
"questionId": "450CF534-DEF1-4B67-63A2-08DA529E6617",
"answer": "This is an example of an answer."
}
]
}
Required parameters:
- Requestor Email: This should be a valid active email address associated with Summize.
- QuestionAnswers: This should be a valid array containing one or more objects, structured as follows:
- QuestionId: Please provide a valid question GUID, this can be obtained from the Questions endpoint.
- Answer: The field should not be empty.
Response:
- 200 OK: This status code is returned, along with a list of links, enabling you to create a new ask legal request.
Error Responses:
- 400 Bad Request: This status code is returned when the required parameters are missing, wrong parameter details, or an invalid JSON format is detected.
- 401 Unauthorized: This status code is returned when an invalid Summize email address is provided.
- 404 Not Found: This status code is returned when the `{baseRequestId}` specified in the URL is not found.
- 500 Internal Error Server: This status code is returned when something goes wrong on our servers.
Upload Attachment
Verb: POST
Endpoint: `/api/requests/review/{baseRequestId}/attachment`
Description: This endpoint is used to upload multiple attachments. Please note that only one attachment can be uploaded at a time, and the file name must be unique and different from any previously uploaded attachments.
Query Parameters:
- api-version: Must be ‘V2’
- baseRequestId: the id of the request obtained from the ‘Base’ call
Body: Please ensure you provide an HTTP multipart request with the following parameters:
Required parameters:
- Requestor Email: This should be a valid active email address associated with Summize.
- File: Please provide a file name with the extension and ensure that the file type is limited to .pdf and .docx formats.
Response:
- 200 OK: This status code is returned, along with a list of links, enabling you to create a new review request.
Error Responses:
- 400 Bad Request: This status code is returned when the required parameters are missing, wrong parameter details, or an invalid multipart request format is detected.
- 401 Unauthorized: This status code is returned when an invalid Summize email address is provided.
- 404 Not Found: This status code is returned when the `{baseRequestId}` specified in the URL is not found.
- 409 Conflict: This status code is returned when there is already an attachment with the same file name associated with the current review request.
- 500 Internal Error Server: This status code is returned when something goes wrong on our servers.
Populate Answers
Verb: POST
Endpoint: `/api/requests/review/{baseRequestId}/answers`
Description: This endpoint allows you to add multiple answers that are related to their respective question IDs.
Query Parameters:
- api-version: Must be ‘V2’
- baseRequestId: the id of the request obtained from the ‘Base’ call
Body: It is essential to provide a properly formatted JSON payload. Please refer to the example below for guidance:
{
"requestorEmail": "example@summize.com",
"questionsAnswers":[
{
"questionId": "AF979852-E2C5-4443-82D0-08DB4C792635",
"answer": "This is an example of an answer."
},
{
"questionId": "450CF534-DEF1-4B67-63A2-08DA529E6617",
"answer": "This is an example of an answer."
}
]
}
Required parameters:
- Requestor Email: This should be a valid active email address associated with Summize.
- QuestionAnswers: This should be a valid array containing one or more objects, structured as follows:
- QuestionId: Please provide a valid question GUID, this can be obtained from the Questions endpoint
- Answer: The field should not be empty.
Response:
- 200 OK: This status code is returned, along with a list of links, enabling you to create a new review request.
Error Responses:
- 400 Bad Request: This status code is returned when the required parameters are missing, wrong parameter details, or an invalid JSON format is detected.
- 401 Unauthorized: This status code is returned when an invalid Summize email address is provided.
- 404 Not Found: This status code is returned when the `{baseRequestId}` specified in the URL is not found.
- 500 Internal Error Server: This status code is returned when something goes wrong on our servers.
Process
Verb: POST
Endpoint: `/api/requests/review/{baseRequestId}/process`
Description: This endpoint serves as the final step in creating a new review request. Please note that once a successful response is received, you will no longer be able to trigger this endpoint. Additionally, the data stored for the other associated endpoints will be deleted.
Query Parameters:
- api-version: Must be ‘V2’
- baseRequestId: the id of the request obtained from the ‘Base’ call
Body: It is essential to provide a properly formatted JSON payload. Please refer to the example below for guidance:
{
"requestorEmail": "example@summize.com"
}
Required parameters:
- Requestor Email: This should be a valid active email address associated with Summize.
Response:
- 200 OK: This status code is returned, along with a status link, enabling you to check the process of the request.
Error Responses:
- 400 Bad Request: This status code is returned when the required parameters are missing, wrong parameter details, or an invalid JSON format is detected.
- 401 Unauthorized: This status code is returned when an invalid Summize email address is provided.
- 500 Internal Error Server: This status code is returned when something goes wrong on our servers.
Submit Ask Legal Endpoints
This collection of endpoints is used to submit a request to Ask Legal. At a minimum, three calls are required:
- Initial: Create a pending Ask Legal request
- Answers: submit the answers to the Ask Legal template
- Process: Instructs the application to complete the Ask Legal request.
It is possible to include attachments to Ask Legal template questions, this is an optional call and should be made after the Answers endpoint is called.
Create Ask Legal Request
Verb: POST
Endpoint: `/api/requests/asklegal`
Description: This endpoint is the starting point for creating a new Ask Legal request.
Query Parameters:
- api-version: Must be ‘V2’
Body: It is essential to provide a properly formatted JSON payload. Please refer to the example below for guidance:
{
"templateId": "6AC27292-C034-41B9-149B-08DB4AE55336",
"requestName": "New asklegal request",
"requestorEmail": "example@summize.com",
}
Required parameters:
- Requestor Email: This should be a valid active email address associated with Summize.
- Template Id: This should be a valid GUID representing an existing template within Summize.
- Request Name: Please specify the name for the new ask legal request.
Optional parameters:
- Source: Please specify the request source from which you would like to set a new ask legal request, for example, Salesforce.
Response:
- 200 OK: This status code is returned, along with a list of links, enabling you to create a new ask legal request.
{
"base": "/api/requests/asklegal",
"attachment": "/api/requests/asklegal/5be1e9fe-0492-45bd-a963-bdbb290c4a28/attachment",
"answers": "/api/requests/asklegal/5be1e9fe-0492-45bd-a963-bdbb290c4a28/answers",
"process": "/api/requests/asklegal/5be1e9fe-0492-45bd-a963-bdbb290c4a28/process"
}
Error Responses:
- 400 Bad Request: This status code is returned when the required parameters are missing, wrong parameter details, or an invalid JSON format is detected.
- 401 Unauthorized: This status code is returned when an invalid Summize email address is provided.
- 500 Internal Error Server: This status code is returned when something goes wrong on our servers.
Upload Attachment
Verb: POST
Endpoint: `/api/requests/asklegal/{baseRequestId}/attachment` (POST)
Description: This endpoint is used to upload multiple attachments. Please note that only one attachment can be uploaded at a time, and the file name must be unique and different from any previously uploaded attachments.
Query Parameters:
- api-version: Must be ‘V2’
- baseRequestId: the id of the request obtained from the ‘Base’ call
Body: Please ensure you provide an HTTP multipart request with the following parameters:
Required parameters:
- Requestor Email: This should be a valid active email address associated with Summize.
- File: Please provide a file name with the extension and ensure that the file type is limited to .pdf and .docx formats.
Response:
- 200 OK: This status code is returned, along with a list of links, enabling you to create a new asklegal request.
Error Responses:
- 400 Bad Request: This status code is returned when the required parameters are missing, wrong parameter details, or an invalid multipart request format is detected.
- 401 Unauthorized: This status code is returned when an invalid Summize email address is provided.
- 404 Not Found: This status code is returned when the `{baseRequestId}` specified in the URL is not found.
- 409 Conflict: This status code is returned when there is already an attachment with the same file name associated with the current asklegal request.
- 500 Internal Error Server: This status code is returned when something goes wrong on our servers.
Populate Answers
Verb: POST
Endpoint: `/api/requests/asklegal/{baseRequestId}/answers`
Description: This endpoint allows you to add multiple answers that are related to their respective question IDs.
Query Parameters:
- api-version: Must be ‘V2’
- baseRequestId: the id of the request obtained from the ‘Base’ call
Body: It is essential to provide a properly formatted JSON payload. Please refer to the example below for guidance:
{
"requestorEmail": "example@summize.com",
"questionsAnswers":[
{
"questionId": "AF979852-E2C5-4443-82D0-08DB4C792635",
"answer": "This is an example of an answer."
},
{
"questionId": "450CF534-DEF1-4B67-63A2-08DA529E6617",
"answer": "This is an example of an answer."
}
]
}
Required parameters:
- Requestor Email: This should be a valid active email address associated with Summize.
- QuestionAnswers: This should be a valid array containing one or more objects, structured as follows:
- QuestionId: Please provide a valid question GUID, this can be obtained from the Questions endpoint.
- Answer: The field should not be empty.
Response:
- 200 OK: This status code is returned, along with a list of links, enabling you to create a new ask legal request.
Error Responses:
- 400 Bad Request: This status code is returned when the required parameters are missing, wrong parameter details, or an invalid JSON format is detected.
- 401 Unauthorized: This status code is returned when an invalid Summize email address is provided.
- 404 Not Found: This status code is returned when the `{baseRequestId}` specified in the URL is not found.
- 500 Internal Error Server: This status code is returned when something goes wrong on our servers.
Process
Verb: POST
Endpoint: `/api/requests/asklegal/{baseRequestId}/process`
Description: This endpoint serves as the final step in creating a new ask legal request. Please note that once a successful response is received, you will no longer be able to trigger this endpoint. Additionally, the data stored for the other associated endpoints will be deleted.
Query Parameters:
- api-version: Must be ‘V2’
- baseRequestId: the id of the request obtained from the ‘Base’ call
Body: It is essential to provide a properly formatted JSON payload. Please refer to the example below for guidance:
{
"requestorEmail": "example@summize.com"
}
Required parameters:
- Requestor Email: This should be a valid active email address associated with Summize.
Response:
- 200 OK: This status code is returned, along with a status link, enabling you to check the process of the request.
Error Responses:
- 400 Bad Request: This status code is returned when the required parameters are missing, wrong parameter details, or an invalid JSON format is detected.
- 401 Unauthorized: This status code is returned when an invalid Summize email address is provided.
- 500 Internal Error Server: This status code is returned when something goes wrong on our servers.
Submit Repository Endpoints
Start submission
Verb: POST
Endpoint: `/api/requests/manage`
Description: This endpoint is the starting point for creating a new manage request.
Query Parameters:
- api-version: Must be ‘V2’
- baseRequestId: the id of the request obtained from the ‘Base’ call
Body: It is essential to provide a properly formatted JSON payload. Please refer to the example below for guidance:
{
"requestorEmail": "example@summize.com",
"clientId": "6AC27292-C034-41B9-149B-08DB4AE55336",
"matterId": "6AC27292-C034-41B9-149B-08DB4AE55336",
"documentTypeId": "6AC27292-C034-41B9-149B-08DB4AE55336",
}
Required parameters:
- Requestor Email: This should be a valid active email address associated with Summize.
- Client Id: Please provide a valid GUID representing an existing parent folder within Summize where contracts are stored.
- Matter Id: Please provide a valid GUID representing an existing child folder within Summize where contracts are stored.
- Document Type Id: Please provide a valid GUID.
Optional parameters:
- Source: Please specify the request source from which you would like to set a new manage request, for example, Salesforce.
Response:
- 200 OK: This status code is returned, along with a list of links, enabling you to create a new manage request.
{
"base": "/api/requests/manage",
"masterDocument": "/api/requests/manage/5be1e9fe-0492-45bd-a963-bdbb290c4a28/masterDocument",
"linkedDocument": "/api/requests/manage/5be1e9fe-0492-45bd-a963-bdbb290c4a28/linkedDocument",
"attachment": "/api/requests/manage/5be1e9fe-0492-45bd-a963-bdbb290c4a28/attachment",
"process": "/api/requests/manage/5be1e9fe-0492-45bd-a963-bdbb290c4a28/process"
}
Error Responses:
- 400 Bad Request: This status code is returned when the required parameters are missing, wrong parameter details, or an invalid JSON format is detected.
- 401 Unauthorized: This status code is returned when an invalid Summize email address is provided.
- 500 Internal Error Server: This status code is returned when something goes wrong on our servers.
Upload Master Document
Verb: POST
Document Endpoint: `/api/requests/manage/{baseRequestId}/masterDocument`
Description: This endpoint is used to upload the master document. Note that there can only be one master document per manage request.
Query Parameters:
- api-version: Must be ‘V2’
- baseRequestId: the id of the request obtained from the ‘Base’ call
Body: Please ensure you provide an HTTP multipart request with the following parameters:
Required parameters:
- Requestor Email: This should be a valid active email address associated with Summize.
- File: Please provide a file name with the extension, and ensure that the file type is limited to .pdf and .docx formats.
Response:
- 200 OK: This status code is returned, along with a list of links, enabling you to create a new manage request.
Error Responses:
- 400 Bad Request: This status code is returned when the required parameters are missing, wrong parameter details, or an invalid multipart request format is detected.
- 401 Unauthorized: This status code is returned when an invalid Summize email address is provided.
- 404 Not Found: This status code is returned when the `{baseRequestId}` specified in the URL is not found.
- 409 Conflict: This status code is returned when there is already a master document associated with the current manage request.
- 500 Internal Error Server: This status code is returned when something goes wrong on our servers.
Upload Linked Document
Verb: POST
Endpoint: `/api/requests/manage/{baseRequestId}/linkedDocument`
Description: This endpoint is used to upload multiple linked documents. Please note that only one linked document can be uploaded at a time, and the file name must be unique and different from any previously uploaded linked documents.
Query Parameters:
- api-version: Must be ‘V2’
- baseRequestId: the id of the request obtained from the ‘Base’ call
Body: Please ensure you provide an HTTP multipart request with the following parameters:
Required parameters:
- Requestor Email: This should be a valid active email address associated with Summize.
- File: Please provide a file name with the extension and ensure that the file type is limited to .pdf and .docx formats.
- DocumentType: Please specify a valid document type from the following options: “Master”, “Variation”, “Addendum”, “Novation”, “SOW”, “OrderForm”.
Response:
- 200 OK: This status code is returned, along with a list of links, enabling you to create a new manage request.
Error Responses:
- 400 Bad Request: This status code is returned when the required parameters are missing, wrong parameter details, or an invalid multipart request format is detected.
- 401 Unauthorized: This status code is returned when an invalid Summize email address is provided.
- 404 Not Found: This status code is returned when the `{baseRequestId}` specified in the URL is not found.
- 409 Conflict: This status code is returned when there is already a linked document with the same file name associated with the current manage request.
- 500 Internal Error Server: This status code is returned when something goes wrong on our servers.
Upload Attachment
Verb: POST
Endpoint: `/api/requests/manage/{baseRequestId}/attachment`
Description: This endpoint is used to upload multiple attachments. Please note that only one attachment can be uploaded at a time, and the file name must be unique and different from any previously uploaded attachments.
Query Parameters:
- api-version: Must be ‘V2’
- baseRequestId: the id of the request obtained from the ‘Base’ call
Body: Please ensure you provide an HTTP multipart request with the following parameters:
Required parameters:
- Requestor Email: This should be a valid active email address associated with Summize.
- File: Please provide a file name with the extension
Response:
- 200 OK: This status code is returned, along with a list of links, enabling you to create a new manage request.
Error Responses:
- 400 Bad Request: This status code is returned when the required parameters are missing, wrong parameter details, or an invalid multipart request format is detected.
- 401 Unauthorized: This status code is returned when an invalid Summize email address is provided.
- 404 Not Found: This status code is returned when the `{baseRequestId}` specified in the URL is not found.
- 409 Conflict: This status code is returned when there is already an attachment with the same file name associated with the current manage request.
- 500 Internal Error Server: This status code is returned when something goes wrong on our servers.
Process
Verb: POST
Endpoint: `/api/requests/manage/{baseRequestId}/process`
Description: This endpoint serves as the final step in creating a new manage request. Please note that once a successful response is received, you will no longer be able to trigger this endpoint. Additionally, the data stored for the other associated endpoints will be deleted.
Query Parameters:
- api-version: Must be ‘V2’
- baseRequestId: the id of the request obtained from the ‘Base’ call
Body: It is essential to provide a properly formatted JSON payload. Please refer to the example below for guidance:
{
"requestorEmail": "example@summize.com"
}
Required parameters:
- Requestor Email: This should be a valid active email address associated with Summize.
Response:
- 200 OK: This status code is returned, along with a status link, enabling you to check the process of the request.
Error Responses:
- 400 Bad Request: This status code is returned when the required parameters are missing, wrong parameter details, or an invalid JSON format is detected.
- 401 Unauthorized: This status code is returned when an invalid Summize email address is provided.
- 500 Internal Error Server: This status code is returned when something goes wrong on our servers.
Status Endpoints
Get Status
Verb: GET
Endpoint: `/api/requests/{requestId}/status`
Description: This endpoint will return the status and a brief summary of the request
Query Parameters:
- api-version: Must be ‘V2’
- requestId: The id of the request obtained from the ‘Process call
- requestorEmail: Email address of the user
Example response:
{
"documentId": "86fc258d-7eeb-4239-a663-bdb7ef59e331",
"requestSubtype": 2,
"requestName": "#3166 Review - Review",
"requestedBy": "b22a4d35-b9ee-4c31-b3ef-417441530835",
"requestedByName": "Test User",
"requestedAt": "2024-07-09T20:21:31.7465455",
"requestStage": "SentForSignature",
"updatedAt": "2024-07-09T20:32:48.3277689",
"updatedBy": "b22a4d35-b9ee-4c31-b3ef-417441530835",
"assignedTo": "e256263a-a584-42d1-b7ed-da74ae092cdb",
"assignedToName": "Test User2",
"assignedAt": "2024-07-09T20:23:57.5987577"
}
Error Responses:
- 400 Bad Request: This status code is returned when the required parameters are missing, wrong parameter details, or an invalid JSON format is detected. Details will be in the message for the specific error.
Update Status
Verb: PUT
Endpoint: `/api/requests/{requestId}/status`
Description: This endpoint for updating the status on the provided request
Query Parameters:
- api-version: Must be ‘V2’
- requestId: The id of the request obtained from the ‘Process call
Body: It is essential to provide a properly formatted JSON payload. Please refer to the example below for guidance. The below are the available statuses. It is essential that the correct status is used for the request type.
|
Value |
Name |
|
1 |
NoValue |
|
10 |
Draft |
|
11 |
Negotiation |
|
12 |
Completed |
|
13 |
Negotiation3rdParty |
|
14 |
ReadyForSignature |
|
15 |
SentForSignature |
|
20 |
Active |
|
21 |
Expired |
|
22 |
Archived |
|
40 |
Open |
|
41 |
Closed |
|
90 |
Abandoned |
|
99 |
NotSet |
{
"status": 41 | “Closed”
"requestorEmail": "example@summize.com"
}
Example response:
{
"success": true
}
Error Responses:
- 400 Bad Request: This status code is returned when the required parameters are missing, wrong parameter details, or an invalid JSON format is detected. Details will be in the message for the specific error.
Process Status Endpoints
Get Process Status
Verb: GET
Endpoint: `/api/requests/{pendingRequestId}/process/status`
Description: This endpoint will return the status of the request's process and an error message if needed.
Query Parameters:
- api-version: Must be ‘V2’
- requestId: The id of the request obtained from the ‘Process call'
Example response:
{
"Status": "Failed",
"ErrorMessage": "Invalid Master Document",
}
Error Responses:
- 404 Not Found: This status code is returned when the required parameters are missing.
Task Endpoints
Get Task
Verb: GET
Endpoint: `/api/requests/{requestId}/tasks`
Description: This endpoint will return the tasks for the request id, it will also return the assignments for each task
Query Parameters:
- api-version: Must be ‘V2’
- requestId: The id of the request obtained from the ‘Process call
- requestorEmail: Email address of the user
Example response:
[
{
"task": {
"taskInstanceId": "c26259fb-f25a-4192-bba6-08b362247e41",
"taskDefinitionId": "b4c14a20-4bbb-4163-9ab3-9924962caf95",
"tenantId": "d2d6fa3b-47c0-4b8a-98aa-08daef01d894",
"departmentId": "d2d6fa3b-47c0-4b8a-98aa-08daef01d894",
"requestTemplateId": "9f6155e8-0e79-4c36-ba56-08dc11d27323",
"taskType": 3,
"dueInDays": 1,
"dueDate": "2024-07-10T00:00:00",
"dueDateUtc": "2024-07-10T22:59:59.999Z",
"taskTitle": "Task title",
"taskDescription": "Task description",
"isMandatory": false,
"createdBy": "00000000-0000-0000-0000-000000000000",
"createdAt": "2024-07-09T14:31:57.2352987",
"updatedAt": "0001-01-01T00:00:00",
"updatedBy": "00000000-0000-0000-0000-000000000000",
"deletedAt": "0001-01-01T00:00:00",
"deletedBy": "00000000-0000-0000-0000-000000000000",
"isDeleted": false,
"documentId": "0dd903b8-f31a-4e47-8b0d-b0e30b49187f",
"activeAtStage": 1,
"completedAt": "0001-01-01T00:00:00",
"completedBy": "00000000-0000-0000-0000-000000000000",
"isComplete": false,
"stageWhenComplete": 0,
"completedTimeSeconds": -63856132317,
"completionNotes": null,
"notes": [],
"taskInstanceSchedule": null
},
"assignments": [],
}
}
Error Responses:
- 400 Bad Request: This status code is returned when the required parameters are missing, wrong parameter details, or an invalid JSON format is detected. Details will be in the message for the specific error.
Create Task
Verb: POST
Endpoint: `/api/requests/{requestId}/tasks`
Description: This endpoint for creating a task on a request id, you can also pass assignees into the payload
Query Parameters:
- api-version: Must be ‘V2’
- requestId: The id of the request obtained from the ‘Process call
Body: It is essential to provide a properly formatted JSON payload. Please refer to the example below for guidance.
{
"title": "API Title",
"description": "API Description",
"type": "Approval",
"requestorEmail": "user-admin@summize.com",
"assignments": [
{
"type": "Group",
"name": "Sales"
},
{
"type": "User",
"name": "user@summize.com"
}
]
}
Notes: Assignments is optional and is an array, depending on the type (Group or User) depends on how lookup will be performed. If type is Group then the group name must match what’s in Summize exactly. If the type is User then we will look up the user by the email address. When updating assignments the request must always provide all the assignments and no just delta updates (additions, removals). For example if a request is expected to be assigned to the Sales department then the Sales assignment must be passed in every time and PUT request is performed.
Type can either be General/Approval/Review.
Example response:
Response will be the same as a newly created task. See Task GET for an example response.
Error Responses:
- 400 Bad Request: This status code is returned when the required parameters are missing, wrong parameter details, or an invalid JSON format is detected. Details will be in the message for the specific error.
Update Task
Verb: PUT
Endpoint: `/api/requests/{requestId}/tasks/{taskId}`
Description: This endpoint for updating a task on a request id
Query Parameters:
- api-version: Must be ‘V2’
- requestId: The id of the request obtained from the ‘Process call
- taskId: The id of the request obtained from the Task Get call
Body: It is essential to provide a properly formatted JSON payload. Please refer to the example below for guidance.
{
"title": "API Title",
"description": "API Description",
"requestorEmail": "user-admin@summize.com",
"assignments":…,
“isComplete”:true
}
Notes: Assignments field follows the same format/details as the POST request.
isComplete field can be passed in the payload as true or false. If a task has been complete it can no longer be marked as in progress but title and description can still be updated
Example response:
Response will be the same as a newly created task. See Task GET for an example response.
Error Responses:
400 Bad Request: This status code is returned when the required parameters are missing, wrong parameter details, or an invalid JSON format is detected. Details will be in the message for the specific error.
Delete Task
Verb: DELETE
Endpoint: `/api/requests/{requestId}/tasks/{taskId}`
Description: This endpoint for deleting a task on a request
Query Parameters:
- api-version: Must be ‘V2’
- requestId: The id of the request obtained from the ‘Process call
- taskId: The id of the request obtained from the Task Get call
Body: It is essential to provide a properly formatted JSON payload. Please refer to the example below for guidance.
{
"requestorEmail": "user-admin@summize.com",
}
Example response:
Response will be true if deleted successfully.
Error Responses:
- 400 Bad Request: This status code is returned when the required parameters are missing, wrong parameter details, or an invalid JSON format is detected. Details will be in the message for the specific error.