Create a new matrix

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

Create a new empty matrix. The id field for the matrix and its columns should be left blank; this will be populated by the endpoint.

POST /platform/v1/testForms/{testFormId}/testPhases/{testPhaseId}/matrices

Required OAuth Scopes

graph:write

Parameters

Parameter	In	Type	Required	Description
X-Version	header	string	false	Version of the API (2022-01-01)
testFormId	path	string	true	The unique identifier of the test form
testPhaseId	path	string	true	The unique identifier of the test phase
body	body	Matrix	true	The properties of the matrix to create

Body parameter example

{
  "dataColumns": [
    {
      "externalId": "TA05",
      "name": "PO Number"
    },
    {
      "externalId": "TA06",
      "name": "Amount"
    }
  ],
  "name": "Purchase Orders",
  "resultColumns": [
    {
      "externalId": "TA07",
      "name": "A"
    }
  ]
}

Code Samples

curl

curl -X POST https://api.app.wdesk.com/platform/v1/testForms/{testFormId}/testPhases/{testPhaseId}/matrices \
    -H 'Content-Type: application/json' \
    -H 'Accept: application/json' \
    -H 'Authorization: Bearer {access-token}' \
    -H 'X-Version: 2022-01-01'

httpie

http POST https://api.app.wdesk.com/platform/v1/testForms/{testFormId}/testPhases/{testPhaseId}/matrices \
    X-Version:2022-01-01 \
    Content-Type:application/json \
    Accept:application/json \
    Authorization:"Bearer {access-token}"

wget

wget --method=POST "https://api.app.wdesk.com/platform/v1/testForms/{testFormId}/testPhases/{testPhaseId}/matrices" \
    --output-document -  \ 
    --header 'Content-Type: application/json' \ 
    --header 'Accept: application/json' \ 
    --header 'Authorization: Bearer {access-token}' \
    --header 'X-Version: 2022-01-01'

python

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/testForms/{testFormId}/testPhases/{testPhaseId}/matrices', headers = headers)

print(r.json())

Returns

201 - Created

Details about a matrix, including its name and ID.

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

201 Response

{
  "dataColumns": [
    {
      "externalId": "TA05",
      "id": "d795d7a3-e7f7-4b3f-be6a-109653b2929b",
      "name": "PO Number"
    },
    {
      "externalId": "TA06",
      "id": "fbd818ec-4fd1-42ad-9112-3c80e71dc2dc",
      "name": "Amount"
    }
  ],
  "id": "30053df2-75fa-4a1e-9e8c-0e18cdd66cd1",
  "name": "Purchase Orders",
  "resultColumns": [
    {
      "externalId": "TA07",
      "id": "d795d7a3-e7f7-4b3f-be6a-109653b2c34d",
      "name": "A"
    }
  ]
}

Bad Request

{
  "code": "400BadRequest",
  "message": "The request was unacceptable, often due to a missing or invalid parameter"
}

Unauthorized

{
  "code": "401Unauthorized",
  "message": "No valid API token provided"
}

Forbidden

{
  "code": "403Forbidden",
  "message": "The API token does not have permissions to perform the request"
}

Not Found

{
  "code": "404NotFound",
  "message": "The requested resource could not be found"
}

Conflict

{
  "code": "409Conflict",
  "message": "The request conflicts with another request"
}

Too Many Requests

{
  "code": "429TooManyRequests",
  "message": "Too many requests have been made against the API in too short a time"
}

Internal Server Error

{
  "code": "500InternalServerError",
  "message": "The server encountered an unexpected condition that prevented it from fulfilling the request"
}

Service Unavailable

{
  "code": "503ServiceUnavailable",
  "message": "The server cannot handle the request due to a temporary overload or scheduled maintenance"
}