v1Resources/Clients/postCreate a portal invitation template

Create a portal invitation template

Agency-wide reusable invitation emails require agency-wide client access. Saving creates a new template and never overwrites loaded content. Supported invitation variables only; template names must be unique. PATCH only accepts isDefault=true and transfers the default. Deleting the default restores built-in invitation copy.

post/api/v1/invite-templates
clients:write
Request body
namestringrequired
subjectstringrequired
bodyAbovestringrequired
bodyBelowstringoptional
isDefaultbooleanoptional
Response
dataobjectrequired
templateobjectoptional
idstringoptional
namestringoptional
subjectstringoptional
bodyAbovestringoptional
bodyBelowstringoptional
isDefaultbooleanoptional
updatedAtstringoptional
Errors
400The request is missing a required parameter or is otherwise malformed.
401Missing, invalid, expired, or revoked API key.
403The key lacks the required scope, or isn't authorized for this client/location.
404The resource wasn't found, or doesn't belong to your agency.
409The request conflicts with the current state of the resource — for example, changing the email or phone of a recipient who has already been messaged, or a team invite that was already accepted (or hasn't been accepted yet).
429Too many requests. Retry after the number of seconds in the Retry-After header.
503The service is temporarily unavailable. Retry a credit grant with the same idempotency key.
post/api/v1/invite-templates
Your API key
Request body*
{}

Guides that use this resource