Skip to main content

appConnectorLinkUpsert

Requires at least one of the permissions customers:customer:read, inventory:stock_level:read, inventory:warehouse:read, payments:payment:read, products:product:read, purchase:grn:read, purchase:purchase_invoice:read, purchase:purchase_order:read, sales:credit_note:read, sales:quote:read, sales:sales_invoice:read, sales:sales_order:read, sales:shipment:read or suppliers:supplier:read.

Link an ARC record to its record in the calling app's system. Re-linking moves the link; an external id already linked to another ARC record is refused. Needs write_connector_sync and read access to that kind of record.

Errors: a failed call returns a GraphQL errors entry, not a field on the result, and data may be null or partial. Read the entry's extensions.code and message; every shape and code is in the Error reference.

Example:

mutation AppConnectorLinkUpsert($input: AppConnectorLinkInput!) {
  appConnectorLinkUpsert(input: $input) {
    arcId
    externalId
    externalVersion
    lastSyncedAt
    resource
  }
}

Variables:

{
  "input": {
    "arcId": "id",
    "externalId": "string",
    "resource": "string"
  }
}

Response:

{
  "data": {
    "appConnectorLinkUpsert": {
      "arcId": "id",
      "externalId": "string",
      "externalVersion": "string",
      "lastSyncedAt": "2025-01-15T00:00:00Z",
      "resource": "string"
    }
  }
}
appConnectorLinkUpsert(
  input: AppConnectorLinkInput!
): ConnectorLinkView!

Arguments​

appConnectorLinkUpsert.input ● AppConnectorLinkInput! non-null input​

The link.

Type​

ConnectorLinkView object​

One ARC record linked to its record in a connected system, for one installed app.