Update entity email template

PUT

https://api.mercoa.com/entity/:entityId/email-template/:emailTemplateId

PUT

/entity/:entityId/email-template/:emailTemplateId

1 curl -X PUT https://api.mercoa.com/entity/ent_a0f6ea94-0761-4a5e-a416-3c453cb7eced/email-template/emt_8545a84e-a45f-41bf-bdf1-33b42a55812c \
2      -H "Authorization: Bearer <token>" \
3      -H "Content-Type: application/json" \
4      -d '{
5   "templateType": "PAYMENT",
6   "name": "Generic Payment Email",
7   "subject": "Action Required - Your payment is due",
8   "content": "<h1>Your invoice has been sent.</h1>",
9   "isDefault": true
10 }'

Try it

200Updated

1 {
2   "id": "emt_8545a84e-a45f-41bf-bdf1-33b42a55812c",
3   "entityId": "ent_21661ac1-a2a8-4465-a6c0-64474ba8181d",
4   "templateType": "PAYMENT",
5   "name": "Generic Payment Email",
6   "subject": "Action Required - Your payment is due",
7   "content": "<h1>Your invoice has been sent.</h1>",
8   "isDefault": true
9 }

Update entity email template

Delete entity email template

Update entity email template

Authentication

AuthorizationBearer

Bearer authentication of the form `Bearer <token>`, where token is your auth token.

Path parameters

entityIdstringRequired

Entity ID or Entity ForeignID

emailTemplateIdstringRequired

Email Template ID or Email Template ForeignID

Request

This endpoint expects an object.

templateTypeenumRequired

Allowed values:

namestringRequired

The name of the email template.

subjectstringRequired

The subject of the email template.

contentstringRequired

The HTML content of the email template.

isDefaultbooleanOptional

If true, this email template will be used as the default template for new invoices.

Response

This endpoint returns an object.

idstring

entityIdstring

The ID of the entity that this email template is associated with.

templateTypeenum

Allowed values:

namestring

The name of the email template.

subjectstring

The subject of the email template.

contentstring

The HTML content of the email template.

isDefaultboolean

True if this email template is the default template for new invoices.

Errors

Entity ID or Entity ForeignID

Email Template ID or Email Template ForeignID

Bearer authentication of the form Bearer <token>, where token is your auth token.

1	curl -X PUT https://api.mercoa.com/entity/ent_a0f6ea94-0761-4a5e-a416-3c453cb7eced/email-template/emt_8545a84e-a45f-41bf-bdf1-33b42a55812c \
2	-H "Authorization: Bearer <token>" \
3	-H "Content-Type: application/json" \
4	-d '{
5	"templateType": "PAYMENT",
6	"name": "Generic Payment Email",
7	"subject": "Action Required - Your payment is due",
8	"content": "<h1>Your invoice has been sent.</h1>",
9	"isDefault": true
10	}'

1	{
2	"id": "emt_8545a84e-a45f-41bf-bdf1-33b42a55812c",
3	"entityId": "ent_21661ac1-a2a8-4465-a6c0-64474ba8181d",
4	"templateType": "PAYMENT",
5	"name": "Generic Payment Email",
6	"subject": "Action Required - Your payment is due",
7	"content": "<h1>Your invoice has been sent.</h1>",
8	"isDefault": true
9	}