Associate API: POST /external/api/association

Endpoint: POST /external/api/association

Description

The Associate API associates a Jira issue with a Salesforce record. You can specify whether the association should be view-only and configure automatic push and pull behaviors.

Query Parameters

allowUpsert (boolean, optional): Whether to allow upsert functionality (insert or update).
Default: false

Example

POST /external/api/association?jiraIssueId=11816&replace=true

Response parameters

jiraIssueId (string, required): the Jira issue ID or Jira issue key is the unique identifier of the Jira issue you want to associate.
son (string, required): Salesforce object name, for example, Case, Account, Contact.
soid (string, required): Salesforce object ID for the specific record to be associated with the Jira issue.
viewOnly (boolean, optional): Set to true to create a view-only association.
Default: false
autoPush (boolean, optional): Set to true to enable automatic data push from Jira to Salesforce.
Default: false
autoPull (boolean, optional): Set to true to enable automatic data pull from Jira to Salesforce.
Default: false

Example

{
  "jiraIssueId": "11816", 
  "son": "Case",
  "soid": "500J80000019IF9IAM",
  "viewOnly": false,
  "autoPush": false,
  "autoPull": false
}

Related pages

Authenticate SFJC REST APIs