Add a contact at a partner

POST https://api.suger.cloud/ai/org/{orgId}/prm/partnership/{partnershipId}/contact

Add a person to a partner's Relationship Hub contact list. `partnershipId` is the partnership id from ListPrmPartnerships. First name, last name and a work email are required; an email already on the list is refused with 409. With `createInCrm` the contact is also created on the partnership's linked Salesforce Account: that push runs in the background, and its outcome shows on the contact (`syncStatus` and `syncError` in ListPrmOrgPartnerContacts with `partnershipIds` this partnership). When no Salesforce Account is linked, the contact is saved in Fours only, without an error.

Parameters

NameInTypeRequiredDescription
orgId path string yes Organization ID
partnershipId path string yes Partnership ID

Request Body

Required. Content-Type: application/json · Schema: CreatePrmPartnerContactInput

CreatePrmPartnerContactInput fields:

FieldTypeRequiredDescription
createInCrm boolean no CreateInCrm also pushes the contact to the linked Salesforce Account.
email string yes
firstName string yes
lastName string yes
linkedinUrl string no
phone string no
role PrmContactRole no
source PrmContactSource no
title string no

Responses

200 — OK

Content-Type: application/json · Schema: PrmPartnerHubContactWriteResult

PrmPartnerHubContactWriteResult fields:

FieldTypeRequiredDescription
contact PartnerContact no
sync SyncPrmPartnerContactsResult no

PartnerContact fields:

FieldTypeRequiredDescription
apolloId string no ApolloID is the Apollo.io person ID for re-enrichment.
crmContactId string no CrmContactID is the person's record under the linked CRM Account.
email string no Email is the contact's verified email address.
enrichedAt string no EnrichedAt is the RFC3339 timestamp of the last enrichment.
firstName string no
id string no ID is the partnership_contact row id. Empty until someone acted on the person (added, edited, synced, removed); address such a person by email.
invitationId string no InvitationID and InvitedAt describe the pending invitation when Portal is INVITED.
invitedAt string no
isPrimary boolean no IsPrimary indicates this is the highest-seniority partnership contact.
lastActivityAt string no LastActivityAt is the person's last sign-in to the partner portal.
lastName string no
linkedinUrl string no LinkedinURL is the contact's LinkedIn profile URL.
name string no Name is the contact's full name.
ownDomain boolean no OwnDomain marks a person on the ISV's own email domain. Such rows are returned only with includeOwnDomain and are never synced, invited or made champion.
phone string no
portal PrmContactPortalStatus no
role PrmContactRole no
seniority string no Seniority is the contact's seniority level (e.g., "vp", "director", "manager", "ic").
source PrmContactSource no
syncError string no SyncError is the CRM's error from the last failed sync, verbatim.
syncStatus PrmContactSyncStatus no
title string no Title is the contact's job title/role (e.g., "VP of Partnerships").

SyncPrmPartnerContactsResult fields:

FieldTypeRequiredDescription
queued array<string> no
skipped array<PrmPartnerHubContactRowResult> no

PrmPartnerHubContactRowResult fields:

FieldTypeRequiredDescription
email string no
message string no
status string no Status is ADDED, EXISTING or INVALID for an import; SKIPPED for a sync.

400 — Bad request error

Content-Type: application/json

409 — The email is already on the list

Content-Type: application/json

Example

The request bodies are this operation's documented examples; the response and error bodies are generated from its schema. Substitute your own ids, and set SUGER_TOKEN to a bearer token from the OAuth client-credentials exchange.

Request

curl -X POST 'https://api.suger.cloud/ai/org/{orgId}/prm/partnership/{partnershipId}/contact' \
  -H "Authorization: Bearer $SUGER_TOKEN" \
  -H 'Content-Type: application/json' \
  -d '{
  "firstName": "Dana",
  "lastName": "Reyes",
  "email": "dana.reyes@example.com",
  "title": "Alliances Manager",
  "role": "PARTNER_MANAGER"
}'

Response — 200

{
  "contact": {
    "apolloId": "01H0000000000000000000",
    "crmContactId": "01H0000000000000000000",
    "email": "buyer@example.com",
    "enrichedAt": "string",
    "firstName": "Acme Corp",
    "id": "01H0000000000000000000",
    "invitationId": "01H0000000000000000000",
    "invitedAt": "2026-01-31T12:00:00Z",
    "isPrimary": true,
    "lastActivityAt": "2026-01-31T12:00:00Z",
    "lastName": "Acme Corp",
    "linkedinUrl": "https://example.com"
  },
  "sync": {
    "queued": [
      "string"
    ],
    "skipped": [
      {
        "email": "buyer@example.com",
        "message": "string",
        "status": "string"
      }
    ]
  }
}

Error — 400

"string"

View as Markdown · API reference overview

Spotted something wrong or out of date on this page? Tell us and we'll correct it.