Invitations

Invite another account to connect

Create a source invitation

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

SecurityAPIKey
Request
Request Body schema: application/json
required

Create a new invitation

email
required
string

invite to connect email

description
string

invitation description to be sent in the email

Responses
201

Created

400

Bad request

401

Authorization information is missing or invalid.

429

Too many request

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",
    • "deprecated": false,
    • "see": "5fd4371e940df5a34a3888b2",
    • "field_suffix": "acorp",
    • "invitation_id": "5fd4371e940df5a34a3888b2",
    • "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"
    }
}