post
https://{subdomain}.pinpointhq.com/api/v1/structure_links
Recent Requests
Log in to see full request history
| Time | Status | User Agent | |
|---|---|---|---|
Retrieving recent requests… | |||
Loading…
Request format
In order to create a structure link you must send a JSON:API spec JSON object representing a structure link.
Attributes
| Attribute Name | Data type | Required |
|---|---|---|
accepts_speculative_applications | boolean | No (Defaults to true) |
Required relationships
Depending on the organisational structure in your Pinpoint instance, different relationships will be required when creating a structure link.
As a bare minimum both department and location will be required.
If you have divisions enabled then a division will need to be provided. If you have an additional custom structure group configured then a custom_structure_group_one will also be needed.
Examples
{
"data": {
"type": "structure_links",
"attributes": {},
"relationships": {
"location": {
"data": {
"type": "locations",
"id": "1"
}
},
"department": {
"data": {
"type": "departments",
"id": "1"
}
}
}
}
}{
"data": {
"type": "structure_links",
"attributes": {
"accepts_speculative_applications": true
},
"relationships": {
"location": {
"data": {
"type": "locations",
"id": "1"
}
},
"department": {
"data": {
"type": "departments",
"id": "1"
}
},
"division": {
"data": {
"type": "divisions",
"id": "1"
}
},
"structure_custom_group_one": {
"data": {
"type": "structure_custom_group_ones",
"id": "1"
}
}
}
}
}