Successful email invitation retrieval
Atto Developer Documentation (all)
Download OpenAPI description
Overview
URL
API Support
License
Languages
Servers
UK Environment (Production)
https://uk.api.atto.co/
US Environment (Production)
https://us.api.atto.co/
Connect Invitation API offers the capability to effortlessly send Connect invitations to your users. It is underpinned by Atto's outbound email solution which supports dynamic components that provide flexible email content and customisation. The email subject, sender address and message will be configured in the email template for you by our support team.
Get immediate feedback about email delivery using our v2 webhooks, which will inform you if the invitation email's state has been Sent, Received, Opened, Clicked, or Failed. This provides additional tracking possibilities to build more sophisticated workflows based on time period and see if the customer has actioned a Connect Invitation email during the configured period.
- UK Environment (Production)
https://uk.api.atto.co/connect-invitations/v1/{invitationId}
- US Environment (Production)
https://us.api.atto.co/connect-invitations/v1/{invitationId}
- curl
- JavaScript
- Node.js
- Python
- Java
- C#
- PHP
- Go
- Ruby
- R
- Payload
curl -i -X GET \
'https://uk.api.atto.co/connect-invitations/v1/{invitationId}' \
-H 'Authorization: Bearer <YOUR_TOKEN_HERE>'Response
application/json
{ "data": { "invitationId": "550a4884-8473-4f2e-a6cf-551c16767d59", "recipientName": "string", "recipientEmail": "string", "customerReference": "string", "invitationCreated": "2019-08-24T14:15:22Z", "activities": [ … ] }, "meta": { "totalRecords": 0 } }