Response
Subscription
Email used during purchase
Available options:
pending, active, canceled, paused, failed curl --request GET \
--url https://backyard.posthoot.com/api/v1/subscriptions{
"canceled_at": "<string>",
"createdAt": "<string>",
"current_period_end": "<string>",
"current_period_start": "<string>",
"dodo_customer_id": "<string>",
"dodo_subscription_id": "<string>",
"email": "<string>",
"id": "<string>",
"isDeleted": false,
"metadata": [
123
],
"product": {
"createdAt": "<string>",
"description": "<string>",
"dodo_id": "<string>",
"features": [
{
"createdAt": "<string>",
"enabled": true,
"feature": "email_campaigns",
"id": "<string>",
"isDeleted": false,
"limit": 123,
"product_id": "<string>",
"updatedAt": "<string>"
}
],
"id": "<string>",
"interval": "<string>",
"isDeleted": false,
"name": "<string>",
"price": 123,
"updatedAt": "<string>"
},
"product_id": "<string>",
"status": "pending",
"team": {
"apiKeys": [
{
"createdAt": "<string>",
"expiresAt": "<string>",
"id": "<string>",
"isDeleted": false,
"key": "<string>",
"lastUsedAt": "<string>",
"name": "<string>",
"permissions": [
{
"createdAt": "<string>",
"id": "<string>",
"isDeleted": false,
"key": {},
"keyId": "<string>",
"resourcePermission": {
"createdAt": "<string>",
"id": "<string>",
"isDeleted": false,
"resource": {
"action": "<string>",
"createdAt": "<string>",
"id": "<string>",
"isDeleted": false,
"name": "<string>",
"updatedAt": "<string>"
},
"resourceId": "<string>",
"scope": "<string>",
"updatedAt": "<string>"
},
"resourcePermissionId": "<string>",
"updatedAt": "<string>"
}
],
"team": {},
"teamId": "<string>",
"updatedAt": "<string>"
}
],
"automations": [
{
"createdAt": "<string>",
"description": "<string>",
"edges": [
{
"animated": true,
"automation": {},
"automationId": "<string>",
"createdAt": "<string>",
"id": "<string>",
"isDeleted": false,
"label": "<string>",
"source": {
"automation": {},
"automationId": "<string>",
"createdAt": "<string>",
"data": [
123
],
"edgesFrom": [
{}
],
"edgesTo": [
{}
],
"id": "<string>",
"isDeleted": true,
"updatedAt": "<string>"
},
"sourceId": "<string>",
"target": {
"automation": {},
"automationId": "<string>",
"createdAt": "<string>",
"data": [
123
],
"edgesFrom": [
{}
],
"edgesTo": [
{}
],
"id": "<string>",
"isDeleted": true,
"updatedAt": "<string>"
},
"targetId": "<string>",
"updatedAt": "<string>"
}
],
"id": "<string>",
"isActive": true,
"isDeleted": false,
"name": "<string>",
"nodes": [
{
"automation": {},
"automationId": "<string>",
"createdAt": "<string>",
"data": [
123
],
"edgesFrom": [
{}
],
"edgesTo": [
{}
],
"id": "<string>",
"isDeleted": true,
"updatedAt": "<string>"
}
],
"team": {},
"teamId": "<string>",
"updatedAt": "<string>"
}
],
"campaigns": [
{
"analytics": [
{
"browser": "<string>",
"campaign": {},
"campaignId": "<string>",
"city": "<string>",
"contact": {
"address": "<string>",
"city": "<string>",
"company": "<string>",
"country": "<string>",
"createdAt": "<string>",
"email": "<string>",
"facebook": "<string>",
"firstName": "<string>",
"id": "<string>",
"import": {
"contacts": [
"<any>"
],
"createdAt": "<string>",
"fieldsMap": [
"<any>"
],
"file": {},
"fileId": "<string>",
"id": "<string>",
"isDeleted": true,
"list": {},
"listId": "<string>",
"status": "PENDING",
"team": {},
"teamId": "<string>",
"updatedAt": "<string>"
},
"importId": "<string>",
"instagram": "<string>",
"isDeleted": true,
"lastName": "<string>",
"linkedin": "<string>",
"list": {
"contactImports": [
"<any>"
],
"contacts": [
"<any>"
],
"createdAt": "<string>",
"description": "<string>",
"id": "<string>",
"isDeleted": true,
"name": "<string>",
"team": {},
"teamId": "<string>",
"updatedAt": "<string>"
},
"listId": "<string>",
"metadata": [
123
],
"phone": "<string>",
"state": "<string>",
"status": "ACTIVE",
"tags": [
{}
],
"teamId": "<string>",
"twitter": "<string>",
"updatedAt": "<string>",
"zip": "<string>"
},
"contactId": "<string>",
"country": "<string>",
"createdAt": "<string>",
"deviceType": "desktop",
"email": {
"bcc": "<string>",
"body": "<string>",
"campaign": {},
"campaignId": "<string>",
"category": {
"createdAt": "<string>",
"description": "<string>",
"emails": [
{}
],
"id": "<string>",
"isDeleted": true,
"name": "<string>",
"team": {},
"teamId": "<string>",
"templates": [
{}
],
"updatedAt": "<string>"
},
"categoryId": "<string>",
"cc": "<string>",
"contact": {
"address": "<string>",
"city": "<string>",
"company": "<string>",
"country": "<string>",
"createdAt": "<string>",
"email": "<string>",
"facebook": "<string>",
"firstName": "<string>",
"id": "<string>",
"import": {
"contacts": [
"<any>"
],
"createdAt": "<string>",
"fieldsMap": [
"<any>"
],
"file": {},
"fileId": "<string>",
"id": "<string>",
"isDeleted": true,
"list": {},
"listId": "<string>",
"status": "PENDING",
"team": {},
"teamId": "<string>",
"updatedAt": "<string>"
},
"importId": "<string>",
"instagram": "<string>",
"isDeleted": true,
"lastName": "<string>",
"linkedin": "<string>",
"list": {
"contactImports": [
"<any>"
],
"contacts": [
"<any>"
],
"createdAt": "<string>",
"description": "<string>",
"id": "<string>",
"isDeleted": true,
"name": "<string>",
"team": {},
"teamId": "<string>",
"updatedAt": "<string>"
},
"listId": "<string>",
"metadata": [
123
],
"phone": "<string>",
"state": "<string>",
"status": "ACTIVE",
"tags": [
{}
],
"teamId": "<string>",
"twitter": "<string>",
"updatedAt": "<string>",
"zip": "<string>"
},
"contactId": "<string>",
"createdAt": "<string>",
"data": [
123
],
"error": "<string>",
"from": "<string>",
"id": "<string>",
"isDeleted": true,
"replyTo": "<string>",
"sendAt": "<string>",
"sentAt": "<string>",
"smtpConfig": {
"createdAt": "<string>",
"fromEmail": "<string>",
"host": "<string>",
"id": "<string>",
"isActive": true,
"isDefault": true,
"isDeleted": true,
"maxSendRate": 2,
"password": "<string>",
"port": 32768,
"provider": "CUSTOM",
"requiresAuth": true,
"supportsTls": true,
"teamId": "<string>",
"updatedAt": "<string>",
"username": "<string>"
},
"smtpConfigId": "<string>",
"status": "SENT",
"subject": "<string>",
"team": {},
"teamId": "<string>",
"template": {
"category": {},
"categoryId": "<string>",
"createdAt": "<string>",
"designJson": "<string>",
"emails": [
{}
],
"htmlFile": {
"createdAt": "<any>",
"id": "<any>",
"isDeleted": "<any>",
"name": "<any>",
"path": "<any>",
"signedUrl": "<any>",
"size": "<any>",
"team": "<any>",
"teamId": "<any>",
"type": "<any>",
"updatedAt": "<any>",
"user": "<any>",
"userId": "<any>"
},
"htmlFileId": "<string>",
"id": "<string>",
"isDeleted": true,
"name": "<string>",
"subject": "<string>",
"team": {},
"teamId": "<string>",
"updatedAt": "<string>",
"variables": [
"<string>"
]
},
"templateId": "<string>",
"test": true,
"to": "<string>",
"updatedAt": "<string>"
},
"emailId": "<string>",
"event": "click",
"id": "<string>",
"ipAddress": "<string>",
"isDeleted": false,
"metadata": [
123
],
"os": "<string>",
"region": "<string>",
"timestamp": "<string>",
"updatedAt": "<string>",
"url": "<string>",
"userAgent": "<string>"
}
],
"batchDelay": -9223372036854776000,
"batchSize": 123,
"createdAt": "<string>",
"cronExpression": "<string>",
"description": "<string>",
"id": "<string>",
"isDeleted": false,
"list": {
"contactImports": [
"<any>"
],
"contacts": [
"<any>"
],
"createdAt": "<string>",
"description": "<string>",
"id": "<string>",
"isDeleted": true,
"name": "<string>",
"team": {},
"teamId": "<string>",
"updatedAt": "<string>"
},
"listId": "<string>",
"name": "<string>",
"processed": 123,
"recurringSchedule": "DAILY",
"schedule": "ONE_TIME",
"scheduledFor": "<string>",
"sentEmails": [
{
"bcc": "<string>",
"body": "<string>",
"campaign": {},
"campaignId": "<string>",
"category": {
"createdAt": "<string>",
"description": "<string>",
"emails": [
{}
],
"id": "<string>",
"isDeleted": true,
"name": "<string>",
"team": {},
"teamId": "<string>",
"templates": [
{}
],
"updatedAt": "<string>"
},
"categoryId": "<string>",
"cc": "<string>",
"contact": {
"address": "<string>",
"city": "<string>",
"company": "<string>",
"country": "<string>",
"createdAt": "<string>",
"email": "<string>",
"facebook": "<string>",
"firstName": "<string>",
"id": "<string>",
"import": {
"contacts": [
"<any>"
],
"createdAt": "<string>",
"fieldsMap": [
"<any>"
],
"file": {},
"fileId": "<string>",
"id": "<string>",
"isDeleted": true,
"list": {},
"listId": "<string>",
"status": "PENDING",
"team": {},
"teamId": "<string>",
"updatedAt": "<string>"
},
"importId": "<string>",
"instagram": "<string>",
"isDeleted": true,
"lastName": "<string>",
"linkedin": "<string>",
"list": {
"contactImports": [
"<any>"
],
"contacts": [
"<any>"
],
"createdAt": "<string>",
"description": "<string>",
"id": "<string>",
"isDeleted": true,
"name": "<string>",
"team": {},
"teamId": "<string>",
"updatedAt": "<string>"
},
"listId": "<string>",
"metadata": [
123
],
"phone": "<string>",
"state": "<string>",
"status": "ACTIVE",
"tags": [
{}
],
"teamId": "<string>",
"twitter": "<string>",
"updatedAt": "<string>",
"zip": "<string>"
},
"contactId": "<string>",
"createdAt": "<string>",
"data": [
123
],
"error": "<string>",
"from": "<string>",
"id": "<string>",
"isDeleted": true,
"replyTo": "<string>",
"sendAt": "<string>",
"sentAt": "<string>",
"smtpConfig": {
"createdAt": "<string>",
"fromEmail": "<string>",
"host": "<string>",
"id": "<string>",
"isActive": true,
"isDefault": true,
"isDeleted": true,
"maxSendRate": 2,
"password": "<string>",
"port": 32768,
"provider": "CUSTOM",
"requiresAuth": true,
"supportsTls": true,
"teamId": "<string>",
"updatedAt": "<string>",
"username": "<string>"
},
"smtpConfigId": "<string>",
"status": "SENT",
"subject": "<string>",
"team": {},
"teamId": "<string>",
"template": {
"category": {},
"categoryId": "<string>",
"createdAt": "<string>",
"designJson": "<string>",
"emails": [
{}
],
"htmlFile": {
"createdAt": "<any>",
"id": "<any>",
"isDeleted": "<any>",
"name": "<any>",
"path": "<any>",
"signedUrl": "<any>",
"size": "<any>",
"team": "<any>",
"teamId": "<any>",
"type": "<any>",
"updatedAt": "<any>",
"user": "<any>",
"userId": "<any>"
},
"htmlFileId": "<string>",
"id": "<string>",
"isDeleted": true,
"name": "<string>",
"subject": "<string>",
"team": {},
"teamId": "<string>",
"updatedAt": "<string>",
"variables": [
"<string>"
]
},
"templateId": "<string>",
"test": true,
"to": "<string>",
"updatedAt": "<string>"
}
],
"smtpConfig": {
"createdAt": "<string>",
"fromEmail": "<string>",
"host": "<string>",
"id": "<string>",
"isActive": true,
"isDefault": true,
"isDeleted": true,
"maxSendRate": 2,
"password": "<string>",
"port": 32768,
"provider": "CUSTOM",
"requiresAuth": true,
"supportsTls": true,
"teamId": "<string>",
"updatedAt": "<string>",
"username": "<string>"
},
"smtpConfigId": "<string>",
"status": "DRAFT",
"team": {},
"teamId": "<string>",
"template": {
"category": {},
"categoryId": "<string>",
"createdAt": "<string>",
"designJson": "<string>",
"emails": [
{}
],
"htmlFile": {
"createdAt": "<any>",
"id": "<any>",
"isDeleted": "<any>",
"name": "<any>",
"path": "<any>",
"signedUrl": "<any>",
"size": "<any>",
"team": "<any>",
"teamId": "<any>",
"type": "<any>",
"updatedAt": "<any>",
"user": "<any>",
"userId": "<any>"
},
"htmlFileId": "<string>",
"id": "<string>",
"isDeleted": true,
"name": "<string>",
"subject": "<string>",
"team": {},
"teamId": "<string>",
"updatedAt": "<string>",
"variables": [
"<string>"
]
},
"templateId": "<string>",
"timezone": "<string>",
"updatedAt": "<string>"
}
],
"createdAt": "<string>",
"domains": [
{
"createdAt": "<string>",
"dnsRecord": "<string>",
"domain": "<string>",
"id": "<string>",
"isDeleted": false,
"isVerified": true,
"teamId": "<string>",
"updatedAt": "<string>"
}
],
"emailCategories": [
{
"createdAt": "<string>",
"description": "<string>",
"emails": [
{}
],
"id": "<string>",
"isDeleted": true,
"name": "<string>",
"team": {},
"teamId": "<string>",
"templates": [
{}
],
"updatedAt": "<string>"
}
],
"id": "<string>",
"invites": [
{
"code": "<string>",
"createdAt": "<string>",
"email": "<string>",
"expiresAt": "<string>",
"id": "<string>",
"inviter": {},
"inviterId": "<string>",
"isDeleted": false,
"name": "<string>",
"role": "MEMBER",
"status": "PENDING",
"team": {},
"teamId": "<string>",
"updatedAt": "<string>"
}
],
"isDeleted": false,
"mailingLists": [
{
"contactImports": [
"<any>"
],
"contacts": [
"<any>"
],
"createdAt": "<string>",
"description": "<string>",
"id": "<string>",
"isDeleted": true,
"name": "<string>",
"team": {},
"teamId": "<string>",
"updatedAt": "<string>"
}
],
"models": [
{
"createdAt": "<string>",
"description": "<string>",
"id": "<string>",
"isDeleted": false,
"name": "<string>",
"provider": "<string>",
"team": {},
"teamId": "<string>",
"updatedAt": "<string>"
}
],
"name": "<string>",
"settings": [
{
"branding": {
"createdAt": "<string>",
"dashboardName": "<string>",
"id": "<string>",
"isDeleted": false,
"logoUrl": "<string>",
"updatedAt": "<string>"
},
"brandingSettingsId": "<string>",
"createdAt": "<string>",
"id": "<string>",
"inviteTemplateId": "<string>",
"isDeleted": false,
"teamId": "<string>",
"updatedAt": "<string>",
"welcomeTemplateId": "<string>"
}
],
"smtpConfigs": [
{
"createdAt": "<string>",
"fromEmail": "<string>",
"host": "<string>",
"id": "<string>",
"isActive": true,
"isDefault": true,
"isDeleted": true,
"maxSendRate": 2,
"password": "<string>",
"port": 32768,
"provider": "CUSTOM",
"requiresAuth": true,
"supportsTls": true,
"teamId": "<string>",
"updatedAt": "<string>",
"username": "<string>"
}
],
"updatedAt": "<string>",
"users": [
{
"createdAt": "<string>",
"email": "<string>",
"files": [
{}
],
"firstName": "<string>",
"id": "<string>",
"invites": [
{}
],
"isDeleted": true,
"lastName": "<string>",
"permissions": [
{}
],
"profilePicture": {},
"profilePictureId": "<string>",
"provider": "<string>",
"providerData": [
123
],
"providerId": "<string>",
"role": "SUPER_ADMIN",
"team": {},
"teamId": "<string>",
"updatedAt": "<string>"
}
],
"webhooks": [
{
"createdAt": "<string>",
"deliveries": [
{
"createdAt": "<string>",
"error": "<string>",
"event": "click",
"id": "<string>",
"isDeleted": false,
"payload": [
123
],
"responseBody": "<string>",
"responseCode": 349,
"status": "PENDING",
"updatedAt": "<string>",
"webhookId": "<string>"
}
],
"events": [
"<string>"
],
"id": "<string>",
"isActive": true,
"isDeleted": false,
"name": "<string>",
"secret": "<string>",
"teamId": "<string>",
"updatedAt": "<string>",
"url": "<string>"
}
]
},
"team_id": "<string>",
"trial_end": "<string>",
"updatedAt": "<string>"
}Get the current subscription for the team
curl --request GET \
--url https://backyard.posthoot.com/api/v1/subscriptions{
"canceled_at": "<string>",
"createdAt": "<string>",
"current_period_end": "<string>",
"current_period_start": "<string>",
"dodo_customer_id": "<string>",
"dodo_subscription_id": "<string>",
"email": "<string>",
"id": "<string>",
"isDeleted": false,
"metadata": [
123
],
"product": {
"createdAt": "<string>",
"description": "<string>",
"dodo_id": "<string>",
"features": [
{
"createdAt": "<string>",
"enabled": true,
"feature": "email_campaigns",
"id": "<string>",
"isDeleted": false,
"limit": 123,
"product_id": "<string>",
"updatedAt": "<string>"
}
],
"id": "<string>",
"interval": "<string>",
"isDeleted": false,
"name": "<string>",
"price": 123,
"updatedAt": "<string>"
},
"product_id": "<string>",
"status": "pending",
"team": {
"apiKeys": [
{
"createdAt": "<string>",
"expiresAt": "<string>",
"id": "<string>",
"isDeleted": false,
"key": "<string>",
"lastUsedAt": "<string>",
"name": "<string>",
"permissions": [
{
"createdAt": "<string>",
"id": "<string>",
"isDeleted": false,
"key": {},
"keyId": "<string>",
"resourcePermission": {
"createdAt": "<string>",
"id": "<string>",
"isDeleted": false,
"resource": {
"action": "<string>",
"createdAt": "<string>",
"id": "<string>",
"isDeleted": false,
"name": "<string>",
"updatedAt": "<string>"
},
"resourceId": "<string>",
"scope": "<string>",
"updatedAt": "<string>"
},
"resourcePermissionId": "<string>",
"updatedAt": "<string>"
}
],
"team": {},
"teamId": "<string>",
"updatedAt": "<string>"
}
],
"automations": [
{
"createdAt": "<string>",
"description": "<string>",
"edges": [
{
"animated": true,
"automation": {},
"automationId": "<string>",
"createdAt": "<string>",
"id": "<string>",
"isDeleted": false,
"label": "<string>",
"source": {
"automation": {},
"automationId": "<string>",
"createdAt": "<string>",
"data": [
123
],
"edgesFrom": [
{}
],
"edgesTo": [
{}
],
"id": "<string>",
"isDeleted": true,
"updatedAt": "<string>"
},
"sourceId": "<string>",
"target": {
"automation": {},
"automationId": "<string>",
"createdAt": "<string>",
"data": [
123
],
"edgesFrom": [
{}
],
"edgesTo": [
{}
],
"id": "<string>",
"isDeleted": true,
"updatedAt": "<string>"
},
"targetId": "<string>",
"updatedAt": "<string>"
}
],
"id": "<string>",
"isActive": true,
"isDeleted": false,
"name": "<string>",
"nodes": [
{
"automation": {},
"automationId": "<string>",
"createdAt": "<string>",
"data": [
123
],
"edgesFrom": [
{}
],
"edgesTo": [
{}
],
"id": "<string>",
"isDeleted": true,
"updatedAt": "<string>"
}
],
"team": {},
"teamId": "<string>",
"updatedAt": "<string>"
}
],
"campaigns": [
{
"analytics": [
{
"browser": "<string>",
"campaign": {},
"campaignId": "<string>",
"city": "<string>",
"contact": {
"address": "<string>",
"city": "<string>",
"company": "<string>",
"country": "<string>",
"createdAt": "<string>",
"email": "<string>",
"facebook": "<string>",
"firstName": "<string>",
"id": "<string>",
"import": {
"contacts": [
"<any>"
],
"createdAt": "<string>",
"fieldsMap": [
"<any>"
],
"file": {},
"fileId": "<string>",
"id": "<string>",
"isDeleted": true,
"list": {},
"listId": "<string>",
"status": "PENDING",
"team": {},
"teamId": "<string>",
"updatedAt": "<string>"
},
"importId": "<string>",
"instagram": "<string>",
"isDeleted": true,
"lastName": "<string>",
"linkedin": "<string>",
"list": {
"contactImports": [
"<any>"
],
"contacts": [
"<any>"
],
"createdAt": "<string>",
"description": "<string>",
"id": "<string>",
"isDeleted": true,
"name": "<string>",
"team": {},
"teamId": "<string>",
"updatedAt": "<string>"
},
"listId": "<string>",
"metadata": [
123
],
"phone": "<string>",
"state": "<string>",
"status": "ACTIVE",
"tags": [
{}
],
"teamId": "<string>",
"twitter": "<string>",
"updatedAt": "<string>",
"zip": "<string>"
},
"contactId": "<string>",
"country": "<string>",
"createdAt": "<string>",
"deviceType": "desktop",
"email": {
"bcc": "<string>",
"body": "<string>",
"campaign": {},
"campaignId": "<string>",
"category": {
"createdAt": "<string>",
"description": "<string>",
"emails": [
{}
],
"id": "<string>",
"isDeleted": true,
"name": "<string>",
"team": {},
"teamId": "<string>",
"templates": [
{}
],
"updatedAt": "<string>"
},
"categoryId": "<string>",
"cc": "<string>",
"contact": {
"address": "<string>",
"city": "<string>",
"company": "<string>",
"country": "<string>",
"createdAt": "<string>",
"email": "<string>",
"facebook": "<string>",
"firstName": "<string>",
"id": "<string>",
"import": {
"contacts": [
"<any>"
],
"createdAt": "<string>",
"fieldsMap": [
"<any>"
],
"file": {},
"fileId": "<string>",
"id": "<string>",
"isDeleted": true,
"list": {},
"listId": "<string>",
"status": "PENDING",
"team": {},
"teamId": "<string>",
"updatedAt": "<string>"
},
"importId": "<string>",
"instagram": "<string>",
"isDeleted": true,
"lastName": "<string>",
"linkedin": "<string>",
"list": {
"contactImports": [
"<any>"
],
"contacts": [
"<any>"
],
"createdAt": "<string>",
"description": "<string>",
"id": "<string>",
"isDeleted": true,
"name": "<string>",
"team": {},
"teamId": "<string>",
"updatedAt": "<string>"
},
"listId": "<string>",
"metadata": [
123
],
"phone": "<string>",
"state": "<string>",
"status": "ACTIVE",
"tags": [
{}
],
"teamId": "<string>",
"twitter": "<string>",
"updatedAt": "<string>",
"zip": "<string>"
},
"contactId": "<string>",
"createdAt": "<string>",
"data": [
123
],
"error": "<string>",
"from": "<string>",
"id": "<string>",
"isDeleted": true,
"replyTo": "<string>",
"sendAt": "<string>",
"sentAt": "<string>",
"smtpConfig": {
"createdAt": "<string>",
"fromEmail": "<string>",
"host": "<string>",
"id": "<string>",
"isActive": true,
"isDefault": true,
"isDeleted": true,
"maxSendRate": 2,
"password": "<string>",
"port": 32768,
"provider": "CUSTOM",
"requiresAuth": true,
"supportsTls": true,
"teamId": "<string>",
"updatedAt": "<string>",
"username": "<string>"
},
"smtpConfigId": "<string>",
"status": "SENT",
"subject": "<string>",
"team": {},
"teamId": "<string>",
"template": {
"category": {},
"categoryId": "<string>",
"createdAt": "<string>",
"designJson": "<string>",
"emails": [
{}
],
"htmlFile": {
"createdAt": "<any>",
"id": "<any>",
"isDeleted": "<any>",
"name": "<any>",
"path": "<any>",
"signedUrl": "<any>",
"size": "<any>",
"team": "<any>",
"teamId": "<any>",
"type": "<any>",
"updatedAt": "<any>",
"user": "<any>",
"userId": "<any>"
},
"htmlFileId": "<string>",
"id": "<string>",
"isDeleted": true,
"name": "<string>",
"subject": "<string>",
"team": {},
"teamId": "<string>",
"updatedAt": "<string>",
"variables": [
"<string>"
]
},
"templateId": "<string>",
"test": true,
"to": "<string>",
"updatedAt": "<string>"
},
"emailId": "<string>",
"event": "click",
"id": "<string>",
"ipAddress": "<string>",
"isDeleted": false,
"metadata": [
123
],
"os": "<string>",
"region": "<string>",
"timestamp": "<string>",
"updatedAt": "<string>",
"url": "<string>",
"userAgent": "<string>"
}
],
"batchDelay": -9223372036854776000,
"batchSize": 123,
"createdAt": "<string>",
"cronExpression": "<string>",
"description": "<string>",
"id": "<string>",
"isDeleted": false,
"list": {
"contactImports": [
"<any>"
],
"contacts": [
"<any>"
],
"createdAt": "<string>",
"description": "<string>",
"id": "<string>",
"isDeleted": true,
"name": "<string>",
"team": {},
"teamId": "<string>",
"updatedAt": "<string>"
},
"listId": "<string>",
"name": "<string>",
"processed": 123,
"recurringSchedule": "DAILY",
"schedule": "ONE_TIME",
"scheduledFor": "<string>",
"sentEmails": [
{
"bcc": "<string>",
"body": "<string>",
"campaign": {},
"campaignId": "<string>",
"category": {
"createdAt": "<string>",
"description": "<string>",
"emails": [
{}
],
"id": "<string>",
"isDeleted": true,
"name": "<string>",
"team": {},
"teamId": "<string>",
"templates": [
{}
],
"updatedAt": "<string>"
},
"categoryId": "<string>",
"cc": "<string>",
"contact": {
"address": "<string>",
"city": "<string>",
"company": "<string>",
"country": "<string>",
"createdAt": "<string>",
"email": "<string>",
"facebook": "<string>",
"firstName": "<string>",
"id": "<string>",
"import": {
"contacts": [
"<any>"
],
"createdAt": "<string>",
"fieldsMap": [
"<any>"
],
"file": {},
"fileId": "<string>",
"id": "<string>",
"isDeleted": true,
"list": {},
"listId": "<string>",
"status": "PENDING",
"team": {},
"teamId": "<string>",
"updatedAt": "<string>"
},
"importId": "<string>",
"instagram": "<string>",
"isDeleted": true,
"lastName": "<string>",
"linkedin": "<string>",
"list": {
"contactImports": [
"<any>"
],
"contacts": [
"<any>"
],
"createdAt": "<string>",
"description": "<string>",
"id": "<string>",
"isDeleted": true,
"name": "<string>",
"team": {},
"teamId": "<string>",
"updatedAt": "<string>"
},
"listId": "<string>",
"metadata": [
123
],
"phone": "<string>",
"state": "<string>",
"status": "ACTIVE",
"tags": [
{}
],
"teamId": "<string>",
"twitter": "<string>",
"updatedAt": "<string>",
"zip": "<string>"
},
"contactId": "<string>",
"createdAt": "<string>",
"data": [
123
],
"error": "<string>",
"from": "<string>",
"id": "<string>",
"isDeleted": true,
"replyTo": "<string>",
"sendAt": "<string>",
"sentAt": "<string>",
"smtpConfig": {
"createdAt": "<string>",
"fromEmail": "<string>",
"host": "<string>",
"id": "<string>",
"isActive": true,
"isDefault": true,
"isDeleted": true,
"maxSendRate": 2,
"password": "<string>",
"port": 32768,
"provider": "CUSTOM",
"requiresAuth": true,
"supportsTls": true,
"teamId": "<string>",
"updatedAt": "<string>",
"username": "<string>"
},
"smtpConfigId": "<string>",
"status": "SENT",
"subject": "<string>",
"team": {},
"teamId": "<string>",
"template": {
"category": {},
"categoryId": "<string>",
"createdAt": "<string>",
"designJson": "<string>",
"emails": [
{}
],
"htmlFile": {
"createdAt": "<any>",
"id": "<any>",
"isDeleted": "<any>",
"name": "<any>",
"path": "<any>",
"signedUrl": "<any>",
"size": "<any>",
"team": "<any>",
"teamId": "<any>",
"type": "<any>",
"updatedAt": "<any>",
"user": "<any>",
"userId": "<any>"
},
"htmlFileId": "<string>",
"id": "<string>",
"isDeleted": true,
"name": "<string>",
"subject": "<string>",
"team": {},
"teamId": "<string>",
"updatedAt": "<string>",
"variables": [
"<string>"
]
},
"templateId": "<string>",
"test": true,
"to": "<string>",
"updatedAt": "<string>"
}
],
"smtpConfig": {
"createdAt": "<string>",
"fromEmail": "<string>",
"host": "<string>",
"id": "<string>",
"isActive": true,
"isDefault": true,
"isDeleted": true,
"maxSendRate": 2,
"password": "<string>",
"port": 32768,
"provider": "CUSTOM",
"requiresAuth": true,
"supportsTls": true,
"teamId": "<string>",
"updatedAt": "<string>",
"username": "<string>"
},
"smtpConfigId": "<string>",
"status": "DRAFT",
"team": {},
"teamId": "<string>",
"template": {
"category": {},
"categoryId": "<string>",
"createdAt": "<string>",
"designJson": "<string>",
"emails": [
{}
],
"htmlFile": {
"createdAt": "<any>",
"id": "<any>",
"isDeleted": "<any>",
"name": "<any>",
"path": "<any>",
"signedUrl": "<any>",
"size": "<any>",
"team": "<any>",
"teamId": "<any>",
"type": "<any>",
"updatedAt": "<any>",
"user": "<any>",
"userId": "<any>"
},
"htmlFileId": "<string>",
"id": "<string>",
"isDeleted": true,
"name": "<string>",
"subject": "<string>",
"team": {},
"teamId": "<string>",
"updatedAt": "<string>",
"variables": [
"<string>"
]
},
"templateId": "<string>",
"timezone": "<string>",
"updatedAt": "<string>"
}
],
"createdAt": "<string>",
"domains": [
{
"createdAt": "<string>",
"dnsRecord": "<string>",
"domain": "<string>",
"id": "<string>",
"isDeleted": false,
"isVerified": true,
"teamId": "<string>",
"updatedAt": "<string>"
}
],
"emailCategories": [
{
"createdAt": "<string>",
"description": "<string>",
"emails": [
{}
],
"id": "<string>",
"isDeleted": true,
"name": "<string>",
"team": {},
"teamId": "<string>",
"templates": [
{}
],
"updatedAt": "<string>"
}
],
"id": "<string>",
"invites": [
{
"code": "<string>",
"createdAt": "<string>",
"email": "<string>",
"expiresAt": "<string>",
"id": "<string>",
"inviter": {},
"inviterId": "<string>",
"isDeleted": false,
"name": "<string>",
"role": "MEMBER",
"status": "PENDING",
"team": {},
"teamId": "<string>",
"updatedAt": "<string>"
}
],
"isDeleted": false,
"mailingLists": [
{
"contactImports": [
"<any>"
],
"contacts": [
"<any>"
],
"createdAt": "<string>",
"description": "<string>",
"id": "<string>",
"isDeleted": true,
"name": "<string>",
"team": {},
"teamId": "<string>",
"updatedAt": "<string>"
}
],
"models": [
{
"createdAt": "<string>",
"description": "<string>",
"id": "<string>",
"isDeleted": false,
"name": "<string>",
"provider": "<string>",
"team": {},
"teamId": "<string>",
"updatedAt": "<string>"
}
],
"name": "<string>",
"settings": [
{
"branding": {
"createdAt": "<string>",
"dashboardName": "<string>",
"id": "<string>",
"isDeleted": false,
"logoUrl": "<string>",
"updatedAt": "<string>"
},
"brandingSettingsId": "<string>",
"createdAt": "<string>",
"id": "<string>",
"inviteTemplateId": "<string>",
"isDeleted": false,
"teamId": "<string>",
"updatedAt": "<string>",
"welcomeTemplateId": "<string>"
}
],
"smtpConfigs": [
{
"createdAt": "<string>",
"fromEmail": "<string>",
"host": "<string>",
"id": "<string>",
"isActive": true,
"isDefault": true,
"isDeleted": true,
"maxSendRate": 2,
"password": "<string>",
"port": 32768,
"provider": "CUSTOM",
"requiresAuth": true,
"supportsTls": true,
"teamId": "<string>",
"updatedAt": "<string>",
"username": "<string>"
}
],
"updatedAt": "<string>",
"users": [
{
"createdAt": "<string>",
"email": "<string>",
"files": [
{}
],
"firstName": "<string>",
"id": "<string>",
"invites": [
{}
],
"isDeleted": true,
"lastName": "<string>",
"permissions": [
{}
],
"profilePicture": {},
"profilePictureId": "<string>",
"provider": "<string>",
"providerData": [
123
],
"providerId": "<string>",
"role": "SUPER_ADMIN",
"team": {},
"teamId": "<string>",
"updatedAt": "<string>"
}
],
"webhooks": [
{
"createdAt": "<string>",
"deliveries": [
{
"createdAt": "<string>",
"error": "<string>",
"event": "click",
"id": "<string>",
"isDeleted": false,
"payload": [
123
],
"responseBody": "<string>",
"responseCode": 349,
"status": "PENDING",
"updatedAt": "<string>",
"webhookId": "<string>"
}
],
"events": [
"<string>"
],
"id": "<string>",
"isActive": true,
"isDeleted": false,
"name": "<string>",
"secret": "<string>",
"teamId": "<string>",
"updatedAt": "<string>",
"url": "<string>"
}
]
},
"team_id": "<string>",
"trial_end": "<string>",
"updatedAt": "<string>"
}Subscription
Email used during purchase
Show child attributes
pending, active, canceled, paused, failed Show child attributes
Was this page helpful?