Sign in

v1

latestOpenAPI 3.0.22026-07-24800528.1 KB
Partnerships

Invites or Adds a Partner Member to the given Partnership's Partner Team

Invites or Adds a Partner Member to the given Partnership's Partner Team

post/v2/partnerships/{partner_key}/member

Path parameters

partner_keystring required

The Partner Key of the Partnership that the Partner Member will be added to

Request body

create_userboolean nullable

Whether to create a new user for the Partner Member if they do not already exist

emailstring required

The email address of the Partner Member to be added to the Partner Team

first_namestring nullable

The first name of the Partner Member to be added to the Partner Team

from_emailstring nullable

The Vendor teammate email to use as the sender of the invite, defaults to Vendor owner

last_namestring nullable

The last name of the Partner Member to be added to the Partner Team

Example request

{
  "email": "partner@example.com",
  "first_name": "John",
  "from_email": "owner@vendor.com",
  "last_name": "Doe"
}

Response

Invites or Adds a Partner Member to the given Partnership's Partner Team

messagestring required
statusinteger required