Sage CRM REST API Help

Review
Updated: July 2019
© Copyright 2019 Sage Technologies Limited, publisher of this work. All rights reserved.
No part of this documentation may be copied, photocopied, reproduced, translated, microfilmed, or
otherwise duplicated on any medium without prior written consent of Sage Technologies Limited.
Use of the software programs described herein and this documentation is subject to the End User
Licence Agreement enclosed in the software package, or accepted during system sign-up.
Sage and the Sage logo are registered trademarks or trademarks of The Sage Group PLC. All
other marks are trademarks or registered trademarks of their respective owners.

Sage CRM REST API Help - Review Page 2 of 10

Contents

Landing page 4

Descriptions of methods 5
GET /<Entity> 5
GET /<Entity>('{key}') 6
POST 7
PATCH 8
PUT 9
DELETE 10

Sage CRM REST API Help - Review Page 3 of 10

Landing page

Current text Proposed edit

Text on the green banner:
sData API Documentation
Text below the green banner:
sData API documentation
This is interactive API documentation for sData
Sage CRM RESTful API Help
<To delete>
The RESTful API enables developers and
system administrators to work with custom
entities in Sage CRM by using HTTP requests
and JSON payloads.

With this API, you can programmatically create,

read, update, and delete custom entities on your
Sage CRM system using standard HTTP
methods such as GET, POST, PUT, PATCH,
and DELETE.

To ensure security, the RESTful API receives

requests over HTTPS.

This interactive Help lists all types of custom

entities you can work with via the RESTful API.
The list of supported entities is specific to your
Sage CRM system and includes the custom
entities you have created so far.

For each entity type, this Help describes the

HTTP methods and parameters you can use
and provides sample request URLs and JSON
payloads.

To see how an HTTP method works, click the

Try it out! button provided for the method in this Formatted: Bold
Help. Use this button with caution because it
works with real data in Sage CRM.

Sage CRM REST API Help - Review Page 4 of 10

Descriptions of methods
GET /<Entity>
Current text
Method description:
Get a feed of resources.
Sage CRM REST API Help - Review
Proposed edit
Gets a collection of all resources of this type.
Add a warning next to the Try it out! button:
Warning: Your changes will be applied to data in
Sage CRM.
Page 5 of 10
GET /<Entity>('{key}')
Current text
Method description:
Get single resource.
Key parameter description:
ID of resource that needs to be fetched
Sage CRM REST API Help - Review
Proposed edit
Gets an individual resource.
Use normal font, not bold:
Specifies the ID of the resource to get.
Add a warning next to the Try it out! button:
Warning: Your changes will be applied to data in
Sage CRM.
Page 6 of 10
POST
Current text
Method description:
Create a resource
Body parameter description:
Resource that needs to be added
Tip below the Model Schema box:
Click to set as parameter value
Sage CRM REST API Help - Review
Proposed edit
Creates a resource.
Use normal font, not bold:
Specifies key-value pairs of the resource to
create.
Click to set as parameter value.
(add a full stop at the end of the sentence)
Add a warning next to the Try it out! button:
Warning: Your changes will be applied to data in
Sage CRM.
Page 7 of 10
PATCH
Current text
Method description:
Partially update the resource.
Key parameter description:
Partially update the resource.
Body parameter description:
Resource that needs to be updated
Tip below the Model Schema box:
Click to set as parameter value
Sage CRM REST API Help - Review
Proposed edit
Formatted: Italic
Updates a single key-value pair of the resource.
Use normal font, not bold:
Specifies the ID of the resource to update.
Specifies the key-value pair to update.
Click to set as parameter value.
(add a full stop at the end of the sentence)
Add a warning next to the Try it out! button:
Warning: Your changes will be applied to data in
Sage CRM.
Page 8 of 10
PUT
Current text
Method description:
Update the resource.
Key parameter description:
Update the resource.
Body parameter description:
Resource that needs to be updated
Tip below the Model Schema box:
Click to set as parameter value
Sage CRM REST API Help - Review
Proposed edit
Updates the resource.
Use normal font, not bold:
Specifies the ID of the resource to update.
Specifies the key-value pairs to update. Formatted: Italic
Click to set as parameter value.
(add a full stop at the end of the sentence)
Add a warning next to the Try it out! button:
Warning: Your changes will be applied to data in
Sage CRM.
Page 9 of 10
DELETE
Current text
Method description:
delete the resource.
Key parameter description:
Update the resource.
Sage CRM REST API Help - Review
Proposed edit
Deletes the resource.
Use normal font, not bold:
Specifies the ID of the resource to delete.
Add a warning next to the Try it out! button:
Warning: Your changes will be applied to data in
Sage CRM.
Page 10 of 10