Creates a new integration with attributes, relationships or both
/jsonapi/integrationsCreates a named external system in the resolved adviser’s organisation. It does not issue API credentials. See the external integrations and references guide.
For client-credentials integrations, supply your assigned adviser identifier in the UserId header. See request headers and data access.
Bearer authentication. Confirm your scopes, data access and required adviser context.
Request parameters
include query
Comma-separated relationship paths for the response representation. Use dots for nested relationships.
includearrayArray itemstringfields query
Select response attributes and relationships by resource type, including included resources. Each value is a comma-separated list of public field names, for example fields[articles]=title,body. Does not affect which request fields are written.
fieldsobjectAdditional propertystringRequest body
application/vnd.api+json
Example request body
Illustrative request using reviewed sample values. Replace sample values, resource types and IDs with your own. Optional fields are shown for illustration; follow the field descriptions and business rules.
{
"data": {
"type": "integrations",
"attributes": {
"name": "Partner Portal",
"description": "Customer and opportunity IDs from our partner portal"
}
}
}
Example request
Use your supplied API base URL and replace path placeholders such as {id}. These examples run in your backend or terminal, where your credentials are kept.
curl --globoff --request POST "${API_BASE_URL}/jsonapi/integrations" \
--header "Authorization: Bearer $ACCESS_TOKEN" \
--header "UserId: $ADVISER_CONTACT_ID" \
--header 'Accept: application/vnd.api+json' \
--header 'Content-Type: application/vnd.api+json' \
--data '{
"data": {
"type": "integrations",
"attributes": {
"name": "Partner Portal",
"description": "Customer and opportunity IDs from our partner portal"
}
}
}'
Responses
201 response
Response headers
Location — Location of newly created resourceapplication/vnd.api+jsonmetaobjectread onlyjsonApiobjectread onlylinksall ofread onlyincludedarray · nullableread only
For guidance beyond this operation's schema, see troubleshooting and JSON:API explained.