Skip to main content

Send Invite Emails

POST 
/api/v1/partner-profiles/:profileId/send-invite

Instead of inputting merchant partner information yourself, use a merchant partner's email address(es) to send them to a web link with a prefilled form. If the profileID and email address(es) you send the endpoint are valid, the system will create a prefilled form and will send invitations to the email address(es) you provide (if your inputs aren't valid, you will get the appropriate error messages). As with the other endpoints, you must add your bearer token. Note that if you don't have your profileId, you can get it by calling Structure for Add Merchant Partner Requests and looking at the end of the RequestUrlEndpoint field in the response.

Request​

Path Parameters

    profileId stringrequired

Body

required

    Emailsstring[]

Responses​

Response Headers

    Schema

      Errors

      object[]

    • Array [

      • Codestring
      Messagestring
      AdditionalInfostring

    • ]

      • StatusCodeintegerrequired
      TraceIdstring
      IsSuccessbooleanrequired
      Urlstring