Create Invitation
Create and send an branded email invitation to a specific lead. Rapyd delivers the invitation link via email, and the lead can use it to sign up for the specified offering.
lead
Object containing details about the invited lead.
partner_user
Object containing partner user details.
sign_up_link_id
Identifier of the sign-up link to use for the invitation.
created_at
Time the invitation was created, in Unix time.
created_by
Name of the user who created the invitation.
id
Unique identifier of the invitation.
lead
Object containing details about the invited lead.
link_url
URL of the invitation link sent to the lead.
offering_id
Identifier of the associated offering. String starting with offering_.
offering_name
Name of the offering associated with the invitation.
sign_up_link_id
Identifier of the sign-up link associated with the invitation.
signed_up
Indicates whether the lead completed sign-up.
updated_at
Time the invitation was last updated, in Unix time.
visited
Indicates whether the lead clicked the invitation link.
{base_uri}/partner/onboarding/sign_up_links/invitations
Create Invitation
curl -X POST '{base_uri}/partner/onboarding/sign_up_links/invitations' -H 'access_key: your-access-key-here' \ -H 'Content-Type: application/json' \ -H 'idempotency: your-idempotency-parameter-here' \ -H 'salt: your-random-string-here' \ -H 'signature: your-calculated-signature-here' \ -H 'timestamp: your-unix-timestamp-here' \ -H 'merchant_account_id: your-merchant-account-here' \ --data-raw ' { "partner_user": { "email": "user@example.com" }, "sign_up_link_id": "a564218eda8f854ae26272f64aadb80a761641179e0ba", "lead": { "email": "lead@example.com", "first_name": "John", "last_name": "Doe" } } '{ "status": { "error_code": "", "status": "SUCCESS", "message": "Success", "response_code": "", "operation_id": "2d2e9bdb-8282-4a44-85b9-617d9b023a7d" }, "data": { "link_url": "https://dashboard.rapyd.net/branded-sign-up/partner/ced844d19f96b2eed8986086df2da4500478501fd16e3", "offering_name": "Example Offering", "created_by": "Example User", "created_at": 1779266246, "updated_at": 1779266246, "id": "ced844d19f96b2eed8986086df2da4500478501fd16e3", "sign_up_link_id": "a564218eda8f854ae26272f64aadb80a761641179e0ba", "lead": { "email": "lead@example.com", "full_name": "John Doe" }, "visited": false, "signed_up": false, "offering_id": "offering_7a4e05312b88f2c311cb7e7f5e152571" } }