Create new record edits#

Deprecated

This endpoint is deprecated and may be removed in a future release.

This endpoint was deprecated on 2026-02-12.

It is scheduled for sunset on 2029-01-31.

Description#

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 /platform/v1/graph/edits

Required OAuth Scopes

graph:write

Parameters#

Parameter

In

Type

Required

Description

X-Version

header

string

false

Version of the API (2022-01-01)

body

body

Edits

true

An 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}' \
    -H 'X-Version: 2022-01-01'
http POST https://api.app.wdesk.com/platform/v1/graph/edits \
    X-Version:2022-01-01 \
    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}' \
    --header 'X-Version: 2022-01-01'
import requests

headers = {
  'X-Version': '2022-01-01',
  '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)

print(r.json())

Returns#

201 - Created#

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

400 - Bad Request#

Error response that indicates that the service is not able to process the incoming request. The reason is provided in the error message.

401 - Unauthorized#

Error response that indicates that the service is not able to process the incoming request. The reason is provided in the error message.

403 - Forbidden#

Error response that indicates that the service is not able to process the incoming request. The reason is provided in the error message.

404 - Not Found#

Error response that indicates that the service is not able to process the incoming request. The reason is provided in the error message.

409 - Conflict#

Error response that indicates that the service is not able to process the incoming request. The reason is provided in the error message.

429 - Too Many Requests#

Error response that indicates that the service is not able to process the incoming request. The reason is provided in the error message.

500 - Internal Server Error#

Error response that indicates that the service is not able to process the incoming request. The reason is provided in the error message.

503 - Service Unavailable#

Error response that indicates that the service is not able to process the incoming request. The reason is provided in the error message.

Example Responses#

{
  "recordIdMap": {
    "myTempId123": "3f9d4e19-6281-4efb-8821-709d299809e7"
  }
}
{
  "code": "400BadRequest",
  "message": "The request was unacceptable, often due to a missing or invalid parameter"
}
{
  "code": "401Unauthorized",
  "message": "No valid API token provided"
}
{
  "code": "403Forbidden",
  "message": "The API token does not have permissions to perform the request"
}
{
  "code": "404NotFound",
  "message": "The requested resource could not be found"
}
{
  "code": "409Conflict",
  "message": "The request conflicts with another request"
}
{
  "code": "429TooManyRequests",
  "message": "Too many requests have been made against the API in too short a time"
}
{
  "code": "500InternalServerError",
  "message": "The server encountered an unexpected condition that prevented it from fulfilling the request"
}
{
  "code": "503ServiceUnavailable",
  "message": "The server cannot handle the request due to a temporary overload or scheduled maintenance"
}