Invitations

Invite another account to connect

Create a source invitation

Send an invitation to Account's Team and return a source pending entity

SecurityAPIKey
Request
Request Body schema: application/json
required

Create a new source invitation

One of:
email
required
string

Email address to send invitation to

description
string

Optional invitation description to be sent in the email

Responses
200

OK - Invitation already exists, returning existing entity

201

Created - New invitation created, returning a new pending entity

400

Bad request - Invalid parameters

401

Authorization information is missing or invalid.

422

Unprocessable Entity - Missing required parameters

post/invitations/source
Request samples
application/json
{
  • "email": "mike.jones@example.com",
  • "description": "I invite you to connect to my account"
}
Response samples
application/json
{
  • "message": "Invitation was sent successfully",
  • "entity": {
    • "id": "5fd4371e940df5a34a3888b2",
    • "name": "A Corporation",
    • "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",
    • "module_ids": [
      • "string"
      ],
    • "source": { },
    • "recipient": { },
    • "time_zone": "America/Los Angeles",
    • "trustedform_certified_vendor": true,
    • "website": "http://example.com",
    • "created_at": "2019-08-24T14:15:22Z",
    • "updated_at": "2019-08-24T14:15:22Z"
    }
}

Create a recipient invitation

Send an invitation to Account's Team and return a recipient pending entity

SecurityAPIKey
Request
Request Body schema: application/json
required

Create a recipient invitation

One of:
email
required
string

Email address to send invitation to

description
string

Optional invitation description to be sent in the email

Responses
200

OK - Invitation already exists, returning existing connected entity

201

Created - New invitation created, returning a new pending entity

400

Bad request - Invalid parameters

401

Authorization information is missing or invalid.

422

Unprocessable Entity - Missing required parameters

post/invitations/recipient
Request samples
application/json
{
  • "email": "mike.jones@example.com",
  • "description": "I invite you to connect to my account"
}
Response samples
application/json
{
  • "message": "Invitation was sent successfully",
  • "entity": {
    • "id": "5fd4371e940df5a34a3888b2",
    • "name": "A Corporation",
    • "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",
    • "module_ids": [
      • "string"
      ],
    • "source": { },
    • "recipient": { },
    • "time_zone": "America/Los Angeles",
    • "trustedform_certified_vendor": true,
    • "website": "http://example.com",
    • "created_at": "2019-08-24T14:15:22Z",
    • "updated_at": "2019-08-24T14:15:22Z"
    }
}

Resend an invitation

Resend an expired or pending invitation. Updates the expiration date and resets the invitation status. Works for both source and recipient invitations.

SecurityAPIKey
Request
path Parameters
entityId
required
string

The ID of the pending or expired entity

Example: 64b8f0f5e4b0c3a1d5e6f7a8
Responses
200

OK - Invitation resent successfully

400

Bad request - Invalid parameters or entity not pending/expired

401

Authorization information is missing or invalid

404

Entity not found

put/invitations/{entityId}/resend
Request samples 
Response samples 
application/json
{
  • "message": "Invitation was sent successfully",
  • "entity": {
    • "id": "5fd4371e940df5a34a3888b2",
    • "name": "A Corporation",
    • "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",
    • "module_ids": [
      • "string"
      ],
    • "source": { },
    • "recipient": { },
    • "time_zone": "America/Los Angeles",
    • "trustedform_certified_vendor": true,
    • "website": "http://example.com",
    • "created_at": "2019-08-24T14:15:22Z",
    • "updated_at": "2019-08-24T14:15:22Z"
    }
}