Create Batch
Last updated
Was this helpful?
Last updated
Was this helpful?
POST /public/v1/notifications/batches HTTP/1.1
Host:
Content-Type: application/json
Accept: */*
Content-Length: 156
{
"category": {
"id": "text"
},
"subject": "text",
"body": "text",
"contacts": [
{
"id": "text",
"email": "text"
}
],
"account": {
"id": "text"
},
"buyer": {
"erpCustomerId": "text"
}
}{
"id": "text",
"audit": {
"created": {
"at": "2025-05-12T20:30:04.490Z",
"by": {
"id": "text",
"name": "text",
"icon": "text"
}
},
"updated": {
"at": "2025-05-12T20:30:04.490Z",
"by": {
"id": "text",
"name": "text",
"icon": "text"
}
}
},
"$meta": {
"omitted": [
"text"
]
},
"category": {
"id": "text",
"audit": {
"created": {
"at": "2025-05-12T20:30:04.490Z",
"by": {
"id": "text",
"name": "text",
"icon": "text"
}
},
"updated": {
"at": "2025-05-12T20:30:04.490Z",
"by": {
"id": "text",
"name": "text",
"icon": "text"
}
}
},
"$meta": {
"omitted": [
"text"
]
},
"description": "text",
"optOutAllowed": true,
"shortDescription": "text",
"status": "text",
"name": "text",
"icon": "text",
"statistics": {
"month": {
"bounced": 1,
"complained": 1,
"discarded": 1,
"failed": 1,
"sent": 1,
"total": 1
},
"today": {
"bounced": 1,
"complained": 1,
"discarded": 1,
"failed": 1,
"sent": 1,
"total": 1
},
"week": {
"bounced": 1,
"complained": 1,
"discarded": 1,
"failed": 1,
"sent": 1,
"total": 1
}
}
},
"account": {
"id": "text",
"audit": {
"created": {
"at": "2025-05-12T20:30:04.490Z",
"by": {
"id": "text",
"name": "text",
"icon": "text"
}
},
"updated": {
"at": "2025-05-12T20:30:04.490Z",
"by": {
"id": "text",
"name": "text",
"icon": "text"
}
}
},
"$meta": {
"omitted": [
"text"
]
},
"icon": "text",
"externalIds": {
"pyraTenantId": "123e4567-e89b-12d3-a456-426614174000"
},
"externalId": "text",
"externalName": "text",
"type": "Client",
"status": "Active",
"serviceLevel": "Express",
"address": {
"addressLine1": "text",
"addressLine2": "text",
"postCode": "text",
"city": "text",
"state": "text",
"country": "text"
},
"technicalSupportEmail": "name@gmail.com",
"website": "text",
"description": "text",
"name": "text",
"groups": [
{
"id": "text",
"audit": {
"created": {
"at": "2025-05-12T20:30:04.490Z",
"by": {
"id": "text",
"name": "text",
"icon": "text"
}
},
"updated": {
"at": "2025-05-12T20:30:04.490Z",
"by": {
"id": "text",
"name": "text",
"icon": "text"
}
}
},
"$meta": {
"omitted": [
"text"
]
},
"name": "text",
"description": "text",
"account": {
"id": "text",
"icon": "text",
"type": "Client",
"status": "Active",
"name": "text"
},
"modules": [
{
"id": "text",
"audit": {
"created": {
"at": "2025-05-12T20:30:04.490Z",
"by": {
"id": "text",
"name": "text",
"icon": "text"
}
},
"updated": {
"at": "2025-05-12T20:30:04.490Z",
"by": {
"id": "text",
"name": "text",
"icon": "text"
}
}
},
"$meta": {
"omitted": [
"text"
]
},
"description": "text",
"name": "text",
"code": "text",
"accountTypes": [
"text"
],
"filters": {
"group.buyers": [
"text"
]
},
"settings": {
"sharedAccount": true,
"configurable": true,
"default": true,
"paid": true,
"type": [
"text"
]
}
}
],
"logo": "text",
"isDefault": true,
"users": [
{
"id": "text",
"audit": {
"created": {
"at": "2025-05-12T20:30:04.490Z",
"by": {
"id": "text",
"name": "text",
"icon": "text"
}
},
"updated": {
"at": "2025-05-12T20:30:04.490Z",
"by": {
"id": "text",
"name": "text",
"icon": "text"
}
},
"invitationAcceptedAt": "2025-05-12T20:30:04.490Z"
},
"$meta": {
"omitted": [
"text"
]
},
"email": "text",
"status": "text",
"phone": {
"prefix": "text",
"number": "text"
},
"firstName": "text",
"lastName": "text",
"icon": "text",
"lastLoginAt": "2025-05-12T20:30:04.490Z",
"settings": {
"cultureCode": "text",
"languageCode": "text"
},
"name": "text",
"accounts": "[Circular Reference]",
"currentAccount": {
"id": "text",
"icon": "text",
"type": "Client",
"status": "Active",
"name": "text"
}
}
],
"buyers": [
{
"id": "text",
"audit": {
"created": {
"at": "2025-05-12T20:30:04.490Z",
"by": {
"id": "text",
"name": "text",
"icon": "text"
}
},
"updated": {
"at": "2025-05-12T20:30:04.490Z",
"by": {
"id": "text",
"name": "text",
"icon": "text"
}
},
"activated": {
"at": "2025-05-12T20:30:04.490Z",
"by": {
"id": "text",
"name": "text",
"icon": "text"
}
},
"unassigned": {
"at": "2025-05-12T20:30:04.490Z",
"by": {
"id": "text",
"name": "text",
"icon": "text"
}
},
"disabled": {
"at": "2025-05-12T20:30:04.490Z",
"by": {
"id": "text",
"name": "text",
"icon": "text"
}
}
},
"$meta": {
"omitted": [
"text"
]
},
"icon": "text",
"contact": {
"name": "text",
"firstName": "text",
"lastName": "text",
"email": "name@gmail.com",
"phone": {
"prefix": "text",
"number": "text"
},
"user": {
"id": "text",
"icon": "text",
"name": "text"
}
},
"externalIds": {
"erpCompanyContact": "text",
"erpCustomer": "text",
"accountExternalId": "text"
},
"status": "Active",
"address": {
"addressLine1": "text",
"addressLine2": "text",
"postCode": "text",
"city": "text",
"state": "text",
"country": "text"
},
"taxId": "text",
"account": {
"id": "text",
"icon": "text",
"type": "Client",
"status": "Active",
"name": "text"
},
"name": "text",
"errors": [
{
"id": "text",
"message": "text",
"parameters": null
}
],
"sellers": [
{
"id": "text",
"audit": {
"created": {
"at": "2025-05-12T20:30:04.490Z",
"by": {
"id": "text",
"name": "text",
"icon": "text"
}
},
"updated": {
"at": "2025-05-12T20:30:04.490Z",
"by": {
"id": "text",
"name": "text",
"icon": "text"
}
}
},
"$meta": {
"omitted": [
"text"
]
},
"icon": "text",
"externalId": "text",
"status": "Active",
"currencies": [
"text"
],
"address": {
"addressLine1": "text",
"addressLine2": "text",
"postCode": "text",
"city": "text",
"state": "text",
"country": "text"
},
"name": "text",
"erpLink": {
"id": "text",
"icon": "text",
"name": "text",
"status": "Active"
}
}
]
}
]
}
],
"eligibility": {
"client": true,
"partner": true
}
},
"subject": "text",
"body": "text",
"attachments": [
{
"id": "text",
"audit": {
"created": {
"at": "2025-05-12T20:30:04.490Z",
"by": {
"id": "text",
"name": "text",
"icon": "text"
}
},
"updated": {
"at": "2025-05-12T20:30:04.490Z",
"by": {
"id": "text",
"name": "text",
"icon": "text"
}
}
},
"$meta": {
"omitted": [
"text"
]
},
"name": "text",
"type": "text",
"description": "text",
"filename": "text",
"size": 1,
"contentType": "text",
"request": {
"id": "text",
"audit": {
"created": {
"at": "2025-05-12T20:30:04.490Z",
"by": {
"id": "text",
"name": "text",
"icon": "text"
}
},
"updated": {
"at": "2025-05-12T20:30:04.490Z",
"by": {
"id": "text",
"name": "text",
"icon": "text"
}
}
},
"$meta": {
"omitted": [
"text"
]
},
"externalId": "text",
"name": "text",
"status": "text",
"error": "text",
"from": {
"id": "text",
"icon": "text",
"type": "Client",
"status": "Active",
"name": "text"
},
"requester": {
"id": "text",
"icon": "text",
"name": "text"
},
"assignee": {
"id": "text",
"icon": "text",
"name": "text"
},
"to": {
"id": "text",
"icon": "text",
"type": "Client",
"status": "Active",
"name": "text"
},
"product": {
"id": "text",
"name": "text",
"externalIds": {
"operations": "text"
},
"icon": "text",
"status": "text"
},
"parameters": [
{
"id": "text",
"audit": {
"created": {
"at": "2025-05-12T20:30:04.490Z",
"by": {
"id": "text",
"name": "text",
"icon": "text"
}
},
"updated": {
"at": "2025-05-12T20:30:04.490Z",
"by": {
"id": "text",
"name": "text",
"icon": "text"
}
}
},
"externalId": "text",
"title": "text",
"description": "text",
"value": "text",
"displayOrder": 1,
"constraints": {
"isReadonly": true,
"isOptional": true
},
"typeOptions": null,
"errorMessage": "text",
"errorCode": "text",
"request": {
"id": "text",
"name": "text"
}
}
],
"messages": [
{
"id": "text",
"audit": {
"created": {
"at": "2025-05-12T20:30:04.490Z",
"by": {
"id": "text",
"name": "text",
"icon": "text"
}
},
"updated": {
"at": "2025-05-12T20:30:04.490Z",
"by": {
"id": "text",
"name": "text",
"icon": "text"
}
}
},
"$meta": {
"omitted": [
"text"
]
},
"visibility": {
"client": true,
"operations": true,
"vendor": true
},
"account": {
"id": "text",
"icon": "text",
"type": "Client",
"status": "Active",
"name": "text"
},
"type": "text",
"content": "text",
"request": {
"id": "text",
"name": "text"
}
}
]
}
}
]
}