Request a resource ID

This endpoint is used to generate a resource ID, which represents a snapshot of an org chart. Using a resource ID allows adding team members through multiple requests via the Add org chart endpoint. Different resource ids correspond to different org chart snapshots and are used independently.

Prerequisites

In order to query this API, you would also need to send an access_token as part of the Authorization header. Visit the Authorization section to see the steps for generating an access token.

Endpoint

POST https://public-api.productiv.com/services/push/v1/customer/org-chart

Required Scope https://api.productiv.com/connector.write

Request headers

Parameter	Value
content-type	application/json
Authorization	`Bearer access_token`

Request body

Property	Datatype	Description	Optional
orgChartName	string	The name that will be used for the org chart	No
customFieldsConfig	object	Object containing custom fields to define for the org chart. You can define up to 5 custom fields	Yes

Example request body

{
  "orgChartName": "random_name",
  "customFieldsConfig": {
    "customField1":"Date of Birth",
    "customField2":"Director"
  }
}

Response

If the request is successful, a JSON response will be returned. This JSON object will contain the following parameters:

Parameter	Description
success	Will be set to `true` in the case of a successful response.
id	The resource ID for the org chart.

Example response

{
  "success": true,
  "id": "a356e51f-d6e8-4c08-a137-fde5368d505a"
}