Successful email invitation retrieval
API Reference//
- Sends an email invitation
Overview
Authorization
Gets a single email invitation
Sends an email invitation
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/
- 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 } }
Body
- application/json-patch+json
- application/json
- text/json
- application/*+json
Request details including recipient name, email, etc
Template ID to be used for the email, if not specified the default template from configuration will be used
Name of the recipient (e.g. full name of the person)
Email address of the recipient to whom the email is going to be sent
- UK Environment (Production)
https://uk.api.atto.co/connect-invitations/v1
- US Environment (Production)
https://us.api.atto.co/connect-invitations/v1
- curl
- JavaScript
- Node.js
- Python
- Java
- C#
- PHP
- Go
- Ruby
- R
- Payload
curl -i -X POST \
https://uk.api.atto.co/connect-invitations/v1 \
-H 'Authorization: Bearer <YOUR_TOKEN_HERE>' \
-H 'Content-Type: application/json-patch+json' \
-d '{
"templateId": "string",
"recipientName": "string",
"recipientEmail": "user@example.com",
"customerReference": "string"
}'Response
application/json
{ "data": { "invitationId": "550a4884-8473-4f2e-a6cf-551c16767d59" }, "meta": { "totalRecords": 0 } }