NewsletterContact - OgnianApostolov/builderly-api-docs GitHub Wiki
Model
NewsletterContact newsletterContact {
"_id": {
"autogenerated": "true"
},
"name": {
"type": "string",
"required": "true"
},
"age": {
"type": "number"
},
"email": {
"type": "string",
"unique": "true",
"required": "true",
"trim": "true",
"lowercase": "true"
},
"city": {
"type": "string"
},
"createdAt": {
"autogenerated": "true"
},
"updatedAt": {
"autogenerated": "true"
}
}
Methods
Create new
POST /newsletter_contacts
req.body required
method: 'POST'
{
url: 'https://{{your-builderly-domain}}/newsletter_contacts',
headers,
json: true,
body:
}
Responses
Success - status 200
{}
Error - status 400
{
error_message
}
Retrieve multiple
GET /newsletter_contacts
method: 'GET'
{
url: 'https://{{your-builderly-domain}}/newsletter_contacts',
headers: {
'Authorization': 'Bearer ' + token
},
json: true,
body: {}
}
Responses
Success - status 200
[newsletter_contacts]
Error - status 500
{
error_message
}
- Example usages:
/newsletter_contacts
- Get all newsletter contacts
Retrieve single
GET /newsletter_contacts/:id
method: 'GET'
{
url: 'https://{{your-builderly-domain}}/newsletter_contacts/{{newsletter_contact._id}}',
headers: {
'Authorization': 'Bearer ' + token
},
json: true,
body: {}
}
Responses
Success - status 200
{ newsletter_contact }
Not found - status 404
{}
Error - status 500
{
error_message
}
- Example usages:
/newsletter_contacts/:id
- Retrives a specific newsletter contact
Update single
PATCH /newsletter_contacts/:id
method: 'PATCH'
{
url: 'https://{{your-builderly-domain}}/newsletter_contacts/{{newsletter_contact._id}}',
headers: {
'Authorization': 'Bearer ' + token
},
json: true,
body: {}
}
Responses
Success - status 200
{ newsletter_contact }
Error - status 400
{
error_message
}
Not found - status 404
{}
Delete single
DELETE /newsletter_contacts/:id
method: 'DELETE'
{
url: 'https://{{your-builderly-domain}}/newsletter_contacts/{{newsletter_contact._id}}',
headers: {
'Authorization': 'Bearer ' + token
},
json: true,
body: {}
}
Responses
Success - status 200
{ newsletter_contact }
Not found - status 404
{}
Error - status 500
{
error_message
}