Invite a partner | JazzHQ AI

curl -X POST https://api.jazzhq.ai/api/v1/vendors/partners \
     -H "X-API-KEY: <apiKey>" \
     -H "Content-Type: application/json" \
     -d '{
  "companyName": "Acme Inc",
  "contactName": "Jane Doe",
  "contactEmailAddress": "jane@acme.com"
}'

{
  "success": true,
  "message": "PARTNER_INVITE_SUCCESSFUL",
  "data": {
    "id": 1001,
    "companyName": "string",
    "description": "string",
    "website": "string",
    "country": "string",
    "companySize": "string",
    "contactName": "string",
    "contactEmailAddress": "string",
    "contactPhone": "string",
    "contactRole": "string",
    "type": "string",
    "users": [
      {
        "id": 101,
        "firstName": "string",
        "lastName": "string",
        "emailAddress": "string",
        "phoneNumber": "string",
        "jobTitle": "string",
        "lastActiveAt": "2024-01-15T09:30:00Z"
      }
    ],
    "invitedAt": "2024-01-15T09:30:00Z",
    "createdAt": "2024-01-15T09:30:00Z"
  },
  "timestamp": "2024-01-15T09:30:00Z"
}

Creates a new partner and sends them an invite email.

If a user matching contactEmailAddress already exists, that existing partner is connected to your vendor account instead of creating a duplicate partner record.

Authentication

X-API-KEYstring

Your vendor API key. Required on every request under /api/v1/vendors/**.

Request

This endpoint expects an object.

companyNamestringRequired

contactNamestringRequired

contactEmailAddressstringRequiredformat: "email"

descriptionstring or nullOptional

websitestring or nullOptional

countrystring or nullOptional

companySizestring or nullOptional

contactPhonestring or nullOptional

contactRolestring or nullOptional

typeenum or nullOptional

Allowed values:

userslist of objects or nullOptional

People to invite inside the partner company. Optional - omit it and a single user is created from contactName and contactEmailAddress.

All-or-nothing: if any emailAddress already belongs to an existing user, or repeats within the list, the whole invite is rejected with DUPLICATE_ENTRY and no partner is created.

Response

Partner invited successfully.

successbooleanOptional

messagestringOptional

dataobjectOptional

timestampdatetimeOptional

Errors

400

Bad Request Error

401

Unauthorized Error

500

Internal Server Error