Skip to content
Partner APIs
/
/Invitation

Invitation

APIs for creating and managing developer partner onboarding invitations. These APIs support the initiation of the onboarding process by generating invitation requests tied to a partner email address and a defined validity period. They are used to control partner access to the onboarding flow and ensure that invitation requests remain unique per email address until expiry.

Operations

Create Merchant onboarding Invitation

Request

"This operation creates the partner onboarding email invitation. These are the requirements to create this request:

  • Email Address: Email ID of the developer partner. Only one request can be generated per email address.
  • Request Expiration Days: User needs to specifies how long the onboarding invitation is valid. Once the invitation expires, a new invitation request can be generated on the same email address."
Security
bearerAuth
Bodyapplication/jsonrequired

This creates onboarding email invitation.

partnerEmailIdstringrequired

Developer partner email ID on which onboarding invitation will be sent.

Example:"NS05_merchant@yopmail.com"
expirationDaysnumberrequired

Number of days after which the onboarding invitation expires.

Example:10
curl -i -X POST \
  https://api-sandbox.sendpro360.pitneybowes.com/developerprofile/api/v1/invitation \
  -H 'Authorization: Bearer <YOUR_TOKEN_HERE>' \
  -H 'Content-Type: application/json' \
  -d '{
    "partnerEmailId": "NS05_merchant@yopmail.com",
    "expirationDays": 10
  }'

Responses

The onboarding invitation has been created successfully.

Bodyapplication/json
invitationIdstring

This is a Unique invitation ID against the developer who is inviting partner for onboarding.

Example:"xqlNEXQPL0mEod4"
developerIdstring

This is Developer subscription ID.

Example:"sacd74e"
emailstring

This is developer Partner email ID on which onboarding invitation has been sent.

Example:"NS05_merchant@yopmail.com"
statusstring

This is current status of the onboarding invitation request.

Example:"Invited"
invitationTypestring

This is the type of the invitation.

Example:"ONBOARD_REQUEST"
createdBystring

This is the client ID of the developer who has created the invitation.

Example:"0oa20m6vx3wAZW7FQ0h8"
provisioningRequestIDstring

This is provisioning request ID.

Example:null
archivedboolean

Whether the invitation is archived.

Example:false
insertTimestampstring

Timestamp information about when the invitation was created.

Example:"2024-09-15T12:40:24.256521003Z"
updateTimestampstring

Timestamp information about when the invitation was last updated.

Example:"0001-01-01T00:00:00Z"
expirationDatestring

The date when the onboarding invitation expires. Once this date is reached, the invitation becomes invalid.

Example:"2024-09-25T12:40:24.254719091Z"
Response
{
  "invitationId": "xqlNEXQPL0mEod4",
  "developerId": "sacd74e",
  "email": "NS05_merchant@yopmail.com",
  "status": "Invited",
  "invitationType": "ONBOARD_REQUEST",
  "createdBy": "0oa20m6vx3wAZW7FQ0h8",
  "provisioningRequestID": null,
  "archived": false,
  "link": "https://api-sandbox.sendpro360.pitneybowes.com/merchant-signup?invitationId4&invitationType=ONBOARD_REQUEST",
  "insertTimestamp": "2024-09-15T12:40:24.256521003Z",
  "updateTimestamp": "0001-01-01T00:00:00Z",
  "expirationDate": "2024-09-25T12:40:24.254719091Z"
}