API Reference

Create new record edits


Creates new record edits given their properties. Each edit in the supplied array requires at least an operation and targetId. Up to 1000 edits may be processed per request.
If there are invalid edits, the error details will include a list of errors encountered. Each message will include the zero-based position of the failed edit in the provided list of edits.

POST /graph/edits


Required OAuth Scopes:



bodybodyEditstrueAn array of edits

Body parameter example

    "operation": "create_record",
    "properties": {
      "id": {
        "datatype": "string",
        "value": "User ID for the issue"
      "secondProperty": {
        "datatype": "string",
        "value": "This is a second property"
    "temporaryRecordId": "<user-generated-temporary-id-for-this-issue-record>",
    "type": "Issue"
    "label": "indicates_issue_on_control",
    "operation": "create_relationship",
    "recordId": "<user-generated-temporary-id-for-this-issue-record>",
    "targetId": "085ce4f5-8687-4cb0-aad6-d5c4e1a89a3d"
    "operation": "set_properties",
    "properties": {
      "customProperty": {
        "datatype": "string",
        "value": "This is a custom property"
    "recordId": "085ce4f5-8687-4cb0-aad6-d5c4e1a89a3d"
    "label": "severity_of_issue",
    "operation": "delete_relationship",
    "recordId": "033a531f-c741-4a97-bc09-bb72358e75ad",
    "targetId": "008c4041-e941-4478-88ea-8ae74b21f6bf"
    "operation": "delete_record",
    "recordId": "033a531f-c741-4a97-bc09-bb72358e75ad"

Code Samples

curl -X POST https://api.app.wdesk.com/platform/v1/graph/edits  \ 
-H 'Content-Type: application/json' \ 
-H 'Accept: application/json' \ 
-H 'Authorization: Bearer {access-token}'
http POST https://api.app.wdesk.com/platform/v1/graph/edits  \ 
Content-Type:application/json \ 
Accept:application/json \ 
Authorization:"Bearer {access-token}"
wget --method=POST "https://api.app.wdesk.com/platform/v1/graph/edits" \
 --output-document -  \ 
 --header 'Content-Type: application/json' \ 
 --header 'Accept: application/json' \ 
 --header 'Authorization: Bearer {access-token}'
import requests
headers = {
  'Content-Type': 'application/json',
  'Accept': 'application/json',
  'Authorization': 'Bearer {access-token}'

r = requests.post('https://api.app.wdesk.com/platform/v1/graph/edits', headers = headers)



201 - Created

Returns an EditsResult object containing details about any temporary to actual record ID mappings carried out during the request.

Example Responses

  "recordIdMap": {
    "myTempId123": "3f9d4e19-6281-4efb-8821-709d299809e7"