Creates an association between an existing GlobalContact person and a party.

This endpoint matches Desktop's "Search to Add Contact" functionality.
Works for all party types: Provider, Supplier, Facility, Carrier.

Recent Requests
Log in to see full request history
TimeStatusUser Agent
Retrieving recent requests…
LoadingLoading…
Query Params
string

The requested API version

Body Params

The request containing association information.

Request to associate an existing GlobalContact person with a party (Provider, Supplier, Facility, or Carrier).
Matches Desktop "Search to Add Contact" functionality.

int64
required
≥ 1

The ID of the party (Provider, Supplier, Facility, or Carrier).
This is the Party.Id from Common.Party table.

string
required
length between 0 and 50

The type of party being associated.
Valid values: Provider, Supplier, Facility, Carrier.
Must match the actual PartyType_Id of the specified Party.

int64
required
≥ 1

The ID of the person (GlobalContact) to associate.
Must be PersonType_Id = 14 (GlobalContact).

string | null

Optional contact type classification (e.g., Primary, Emergency, Billing).
Lookup value from Lookups.ContactType table.

string | null

Optional relationship type (e.g., Business Partner, Assistant).
Lookup value from Lookups.RelationshipType table.

Headers
string
enum
Defaults to application/json-patch+json

Generated from available request content types

Allowed:
Responses

Language
URL
LoadingLoading…
Response
Click Try It! to start a request and see the response here! Or choose an example:
application/json