Create a partner

curl --request POST \
  --url https://api.introw.io/api/v1/partners \
  --header 'Content-Type: application/json' \
  --header 'x-api-key: <api-key>' \
  --data '
{
  "name": "Acme Partners"
}
'

const options = {
  method: 'POST',
  headers: {'x-api-key': '<api-key>', 'Content-Type': 'application/json'},
  body: JSON.stringify({name: 'Acme Partners'})
};

fetch('https://api.introw.io/api/v1/partners', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

import requests

url = "https://api.introw.io/api/v1/partners"

payload = { "name": "Acme Partners" }
headers = {
    "x-api-key": "<api-key>",
    "Content-Type": "application/json"
}

response = requests.post(url, json=payload, headers=headers)

print(response.text)

{
  "data": {
    "id": "ptn_01HVK6Y8Z8Q7J8J8J8J8J8J8J8",
    "name": "Acme Partners",
    "domain": "acme.example",
    "externalCompanyId": "company_123",
    "externalId": "partner_123",
    "externalIdType": "PARTNER",
    "managerEmail": "[email protected]",
    "categories": [
      "Reseller"
    ],
    "tierId": "tier_123",
    "phaseId": "phase_123",
    "experienceTemplateId": "tmpl_123",
    "owner": null,
    "manager": null,
    "partnerObjectCrmProperties": {
      "name": "Acme Partners"
    },
    "companyCrmProperties": {
      "domain": "acme.example"
    },
    "crmProperties": {
      "name": "Acme Partners"
    },
    "status": "active",
    "createdAt": "2026-05-08T12:00:00.000Z",
    "updatedAt": "2026-05-08T12:00:00.000Z"
  }
}

{
  "error": {
    "code": "<string>",
    "message": "<string>",
    "details": "<unknown>"
  }
}

{
  "error": {
    "code": "<string>",
    "message": "<string>",
    "details": "<unknown>"
  }
}

{
  "error": {
    "code": "<string>",
    "message": "<string>",
    "details": "<unknown>"
  }
}

{
  "error": {
    "code": "<string>",
    "message": "<string>",
    "details": "<unknown>"
  }
}

{
  "error": {
    "code": "<string>",
    "message": "<string>",
    "details": "<unknown>"
  }
}

{
  "error": {
    "code": "<string>",
    "message": "<string>",
    "details": "<unknown>"
  }
}

Create a partner

Creates a partner in the organisation resolved from the authenticated API key.

Beyond name and domain, you can set configuration in the same call: assign a tierId, set the lifecycle phaseId, designate a partnerOwnerId, and publish an experienceTemplateId (optionally scoping its portal access with portalAccess).

The endpoint is create-or-update: when a partner with the same name/domain already exists, it is patched with the supplied settings rather than duplicated. A freshly created partner returns 201; a matched (updated) partner returns 200.

POST

api

partners

Create a partner

curl --request POST \
  --url https://api.introw.io/api/v1/partners \
  --header 'Content-Type: application/json' \
  --header 'x-api-key: <api-key>' \
  --data '
{
  "name": "Acme Partners"
}
'

const options = {
  method: 'POST',
  headers: {'x-api-key': '<api-key>', 'Content-Type': 'application/json'},
  body: JSON.stringify({name: 'Acme Partners'})
};

fetch('https://api.introw.io/api/v1/partners', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

import requests

url = "https://api.introw.io/api/v1/partners"

payload = { "name": "Acme Partners" }
headers = {
    "x-api-key": "<api-key>",
    "Content-Type": "application/json"
}

response = requests.post(url, json=payload, headers=headers)

print(response.text)

{
  "data": {
    "id": "ptn_01HVK6Y8Z8Q7J8J8J8J8J8J8J8",
    "name": "Acme Partners",
    "domain": "acme.example",
    "externalCompanyId": "company_123",
    "externalId": "partner_123",
    "externalIdType": "PARTNER",
    "managerEmail": "[email protected]",
    "categories": [
      "Reseller"
    ],
    "tierId": "tier_123",
    "phaseId": "phase_123",
    "experienceTemplateId": "tmpl_123",
    "owner": null,
    "manager": null,
    "partnerObjectCrmProperties": {
      "name": "Acme Partners"
    },
    "companyCrmProperties": {
      "domain": "acme.example"
    },
    "crmProperties": {
      "name": "Acme Partners"
    },
    "status": "active",
    "createdAt": "2026-05-08T12:00:00.000Z",
    "updatedAt": "2026-05-08T12:00:00.000Z"
  }
}

{
  "error": {
    "code": "<string>",
    "message": "<string>",
    "details": "<unknown>"
  }
}

{
  "error": {
    "code": "<string>",
    "message": "<string>",
    "details": "<unknown>"
  }
}

{
  "error": {
    "code": "<string>",
    "message": "<string>",
    "details": "<unknown>"
  }
}

{
  "error": {
    "code": "<string>",
    "message": "<string>",
    "details": "<unknown>"
  }
}

{
  "error": {
    "code": "<string>",
    "message": "<string>",
    "details": "<unknown>"
  }
}

{
  "error": {
    "code": "<string>",
    "message": "<string>",
    "details": "<unknown>"
  }
}

Authorizations

x-api-key

string

header

required

Introw API key shown once when the credential is created.

Body

application/json

name

string

required

Partner display name.

Required string length: 1 - 200

domain

string | null

Partner company domain, when known.

Required string length: 1 - 255

portalAccess

enum<string>

Access mode used when publishing the partner's portal. Only takes effect together with experienceTemplateId.

Available options:

RESTRICTED_USERS,

RESTRICTED_DOMAINS

tierId

string

Identifier of the tier to assign to the partner.

Minimum string length: 1

experienceTemplateId

string

Identifier of the experience template to publish for the partner.

Minimum string length: 1

phaseId

string

Identifier of the lifecycle phase to assign to the partner.

Minimum string length: 1

partnerOwnerId

string

Identifier of the Introw user to assign as the partner owner.

Minimum string length: 1

Response

Partner created successfully.

data

object

required

Show child attributes

⌘I

INTROW API

Use cases

Partner API

Forms API

CRM API

Commission payouts API

Commission lines API

Collaboration API

Embed API

Affiliate API

Create a partner

Authorizations

Body

Response