Skip to main content
POST
/
invitations
/
recipient
Create a recipient invitation
curl --request POST \
  --url https://app.leadconduit.com/invitations/recipient \
  --header 'Authorization: Basic <encoded-value>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "email": "mike.jones@example.com"
}
'
{
  "message": "Invitation was sent successfully",
  "entity": {
    "name": "A Corporation",
    "module_ids": [
      "<string>"
    ],
    "source": "form",
    "recipient": "buyer",
    "id": "5fd4371e940df5a34a3888b2",
    "description": "<string>",
    "standard": false,
    "account": true,
    "pending": true,
    "connected": "seller",
    "connected_account_id": "5fd4371e940df5a34a3888b2",
    "deprecated": false,
    "see": "5fd4371e940df5a34a3888b2",
    "field_suffix": "acorp",
    "invitation_id": "5fd4371e940df5a34a3888b2",
    "invitation_expires_at": "2025-11-07T00:00:00Z",
    "expired": false,
    "flow_ids": [
      "5fd4371e940df5a34a3888b2"
    ],
    "logo_url": "<string>",
    "time_zone": "America/Los Angeles",
    "trustedform_certified_vendor": true,
    "website": "<string>",
    "created_at": "2023-11-07T05:31:56Z",
    "updated_at": "2023-11-07T05:31:56Z"
  }
}

Documentation Index

Fetch the complete documentation index at: https://developers.activeprospect.com/llms.txt

Use this file to discover all available pages before exploring further.

Authorizations

Authorization
string
header
required

LeadConduit uses HTTP Basic Authentication with the username API and your API key as the password.

For example: API:1f1b96c9150d8050e858c043d543bb4eadae0e6f'

Body

application/json

Create a recipient invitation

email
string
required

Email address to send invitation to

Example:

"mike.jones@example.com"

Response

OK - Invitation already exists, returning existing connected entity

message
string

Message in case the invitation was sent successfully

Example:

"Invitation was sent successfully"

entity
object

Pending source or recipient entity created with the invitation id returned from Accounts invitations