SAsalesmessage
Organizations Agency

Create agency's invitation

REQUIRED SCOPES <code>['organizations-agency:write']</code><br>Create agency's invitation

post/agency/invites

Request

  • Base URL
    https://api.salesmessage.com/pub/v2.3
  • URL
    https://api.salesmessage.com/pub/v2.3/agency/invites
  • Auth
    HTTP bearer

Request body

emailstring email required

Email

planstring required

Plan

trialboolean

Trial

organization_cloneinteger nullable

Organization clone

affiliate_linkstring nullable

Agency Affiliate Link

payment_methodstring nullable

ID of payment method. It's taken into account when Organization is Franchise

pay_nowboolean nullable

Pay now flag

card_tokenstring nullable

Optional field for card token. It's taken into account when 'pay_now' is TRUE

first_namestring nullable

First name of customer. It's taken into account when 'pay_now' is TRUE

last_namestring nullable

Last name of customer. It's taken into account when 'pay_now' is TRUE

integration_teamsinteger[] nullable

The IDs of the Teams. It's taken into account when groups flow is allowed.

Example request

{
  "email": "test@test.test",
  "trial": true,
  "affiliate_link": "https://www.salesmessage.com/?fp_ref=example"
}

Response

OK

Changes

No recorded changes to this operation across all 3 revisions of this API.