Announcement Templates

Read and manage the global catalog of reusable announcement templates (e.g. "See you later {name}!"). Shared by every company; read by announcement authors, managed by admins.

Update a template

put

Updates an existing template identified by its id. All editable fields are replaced; the id is preserved.

Authorizations

SessionIdstringRequired

SessionId

Path parameters

templateIdstringRequired

Template identifier

Example: 64f8a0e2d5b7c9a1e3f4a5b6

Body

Global reusable announcement template shared by all companies (e.g. "See you later {name}!"). Placeholder tokens are stored verbatim.

idstringRead-onlyOptional

Unique template identifier

Example: 507f1f77bcf86cd799439020

keystringRequired

Stable business key / slug identifying the template

Example: farewell

categorystringOptional

Grouping shown in the dashboard template picker

Example: life-events

coverImageURLstringOptional

Cover/illustration image URL associated with the template

orderinteger · int32Optional

Display ordering within the catalog (ascending)

Example: 1

enabledbooleanOptional

Whether the template is offered to authors; disabled templates are hidden from the picker

Example: true

placeholdersstring[]Optional

Placeholder tokens the template exposes, for the dashboard token palette

Example: ["name"]

Responses

200

Template updated

*/*

Global reusable announcement template shared by all companies (e.g. "See you later {name}!"). Placeholder tokens are stored verbatim.

idstringRead-onlyOptional

Unique template identifier

Example: 507f1f77bcf86cd799439020

keystringRequired

Stable business key / slug identifying the template

Example: farewell

categorystringOptional

Grouping shown in the dashboard template picker

Example: life-events

coverImageURLstringOptional

Cover/illustration image URL associated with the template

orderinteger · int32Optional

Display ordering within the catalog (ascending)

Example: 1

enabledbooleanOptional

Whether the template is offered to authors; disabled templates are hidden from the picker

Example: true

placeholdersstring[]Optional

Placeholder tokens the template exposes, for the dashboard token palette

Example: ["name"]

412

Template not found, validation failed, or key conflict

*/*

put/api/v1/company/announcements/templates/{templateId}

PUT /api/v1/company/announcements/templates/{templateId} HTTP/1.1
Host: api.happyforce.com
SessionId: YOUR_API_KEY
Content-Type: */*
Accept: */*
Content-Length: 427

{
  "key": "farewell",
  "title": {
    "defaultValue": "Happy birthday!",
    "langValues": {
      "ANY_ADDITIONAL_PROPERTY": "text"
    },
    "valid": true
  },
  "body": {
    "defaultValue": "Happy birthday!",
    "langValues": {
      "ANY_ADDITIONAL_PROPERTY": "text"
    },
    "valid": true
  },
  "resume": {
    "defaultValue": "Happy birthday!",
    "langValues": {
      "ANY_ADDITIONAL_PROPERTY": "text"
    },
    "valid": true
  },
  "category": "life-events",
  "coverImageURL": "text",
  "order": 1,
  "enabled": true,
  "placeholders": [
    "name"
  ]
}

{
  "id": "507f1f77bcf86cd799439020",
  "key": "farewell",
  "title": {
    "defaultValue": "Happy birthday!",
    "langValues": {
      "ANY_ADDITIONAL_PROPERTY": "text"
    },
    "valid": true
  },
  "body": {
    "defaultValue": "Happy birthday!",
    "langValues": {
      "ANY_ADDITIONAL_PROPERTY": "text"
    },
    "valid": true
  },
  "resume": {
    "defaultValue": "Happy birthday!",
    "langValues": {
      "ANY_ADDITIONAL_PROPERTY": "text"
    },
    "valid": true
  },
  "category": "life-events",
  "coverImageURL": "text",
  "order": 1,
  "enabled": true,
  "placeholders": [
    "name"
  ]
}

Delete a template

delete

Deletes a template from the global catalog, identified by its id.

Authorizations

SessionIdstringRequired

SessionId

Path parameters

templateIdstringRequired

Template identifier

Example: 64f8a0e2d5b7c9a1e3f4a5b6

Responses

200

Template deleted

*/*

Global reusable announcement template shared by all companies (e.g. "See you later {name}!"). Placeholder tokens are stored verbatim.

idstringRead-onlyOptional

Unique template identifier

Example: 507f1f77bcf86cd799439020

keystringRequired

Stable business key / slug identifying the template

Example: farewell

categorystringOptional

Grouping shown in the dashboard template picker

Example: life-events

coverImageURLstringOptional

Cover/illustration image URL associated with the template

orderinteger · int32Optional

Display ordering within the catalog (ascending)

Example: 1

enabledbooleanOptional

Whether the template is offered to authors; disabled templates are hidden from the picker

Example: true

placeholdersstring[]Optional

Placeholder tokens the template exposes, for the dashboard token palette

Example: ["name"]

412

Template not found

*/*

delete/api/v1/company/announcements/templates/{templateId}

DELETE /api/v1/company/announcements/templates/{templateId} HTTP/1.1
Host: api.happyforce.com
SessionId: YOUR_API_KEY
Accept: */*

{
  "id": "507f1f77bcf86cd799439020",
  "key": "farewell",
  "title": {
    "defaultValue": "Happy birthday!",
    "langValues": {
      "ANY_ADDITIONAL_PROPERTY": "text"
    },
    "valid": true
  },
  "body": {
    "defaultValue": "Happy birthday!",
    "langValues": {
      "ANY_ADDITIONAL_PROPERTY": "text"
    },
    "valid": true
  },
  "resume": {
    "defaultValue": "Happy birthday!",
    "langValues": {
      "ANY_ADDITIONAL_PROPERTY": "text"
    },
    "valid": true
  },
  "category": "life-events",
  "coverImageURL": "text",
  "order": 1,
  "enabled": true,
  "placeholders": [
    "name"
  ]
}

List templates for authoring

get

Returns the enabled templates of the global catalog, ordered for display in the dashboard picker. Placeholder tokens (e.g. {name}) are returned verbatim; the client substitutes them when the author picks a template.

Authorizations

SessionIdstringRequired

SessionId

Responses

200

Enabled templates, ordered ascending

*/*

Global reusable announcement template shared by all companies (e.g. "See you later {name}!"). Placeholder tokens are stored verbatim.

idstringRead-onlyOptional

Unique template identifier

Example: 507f1f77bcf86cd799439020

keystringRequired

Stable business key / slug identifying the template

Example: farewell

categorystringOptional

Grouping shown in the dashboard template picker

Example: life-events

coverImageURLstringOptional

Cover/illustration image URL associated with the template

orderinteger · int32Optional

Display ordering within the catalog (ascending)

Example: 1

enabledbooleanOptional

Whether the template is offered to authors; disabled templates are hidden from the picker

Example: true

placeholdersstring[]Optional

Placeholder tokens the template exposes, for the dashboard token palette

Example: ["name"]

get/api/v1/company/announcements/templates

GET /api/v1/company/announcements/templates HTTP/1.1
Host: api.happyforce.com
SessionId: YOUR_API_KEY
Accept: */*

200

Enabled templates, ordered ascending

[
  {
    "id": "507f1f77bcf86cd799439020",
    "key": "farewell",
    "title": {
      "defaultValue": "Happy birthday!",
      "langValues": {
        "ANY_ADDITIONAL_PROPERTY": "text"
      },
      "valid": true
    },
    "body": {
      "defaultValue": "Happy birthday!",
      "langValues": {
        "ANY_ADDITIONAL_PROPERTY": "text"
      },
      "valid": true
    },
    "resume": {
      "defaultValue": "Happy birthday!",
      "langValues": {
        "ANY_ADDITIONAL_PROPERTY": "text"
      },
      "valid": true
    },
    "category": "life-events",
    "coverImageURL": "text",
    "order": 1,
    "enabled": true,
    "placeholders": [
      "name"
    ]
  }
]

Create a template

post

Creates a new template in the global catalog. The key must be unique and the default title must be non-empty; the generated id is returned.

Authorizations

SessionIdstringRequired

SessionId

Body

Global reusable announcement template shared by all companies (e.g. "See you later {name}!"). Placeholder tokens are stored verbatim.

idstringRead-onlyOptional

Unique template identifier

Example: 507f1f77bcf86cd799439020

keystringRequired

Stable business key / slug identifying the template

Example: farewell

categorystringOptional

Grouping shown in the dashboard template picker

Example: life-events

coverImageURLstringOptional

Cover/illustration image URL associated with the template

orderinteger · int32Optional

Display ordering within the catalog (ascending)

Example: 1

enabledbooleanOptional

Whether the template is offered to authors; disabled templates are hidden from the picker

Example: true

placeholdersstring[]Optional

Placeholder tokens the template exposes, for the dashboard token palette

Example: ["name"]

Responses

200

Template created

*/*

Global reusable announcement template shared by all companies (e.g. "See you later {name}!"). Placeholder tokens are stored verbatim.

idstringRead-onlyOptional

Unique template identifier

Example: 507f1f77bcf86cd799439020

keystringRequired

Stable business key / slug identifying the template

Example: farewell

categorystringOptional

Grouping shown in the dashboard template picker

Example: life-events

coverImageURLstringOptional

Cover/illustration image URL associated with the template

orderinteger · int32Optional

Display ordering within the catalog (ascending)

Example: 1

enabledbooleanOptional

Whether the template is offered to authors; disabled templates are hidden from the picker

Example: true

placeholdersstring[]Optional

Placeholder tokens the template exposes, for the dashboard token palette

Example: ["name"]

412

Validation failed or the key already exists

*/*

post/api/v1/company/announcements/templates

POST /api/v1/company/announcements/templates HTTP/1.1
Host: api.happyforce.com
SessionId: YOUR_API_KEY
Content-Type: */*
Accept: */*
Content-Length: 427

{
  "key": "farewell",
  "title": {
    "defaultValue": "Happy birthday!",
    "langValues": {
      "ANY_ADDITIONAL_PROPERTY": "text"
    },
    "valid": true
  },
  "body": {
    "defaultValue": "Happy birthday!",
    "langValues": {
      "ANY_ADDITIONAL_PROPERTY": "text"
    },
    "valid": true
  },
  "resume": {
    "defaultValue": "Happy birthday!",
    "langValues": {
      "ANY_ADDITIONAL_PROPERTY": "text"
    },
    "valid": true
  },
  "category": "life-events",
  "coverImageURL": "text",
  "order": 1,
  "enabled": true,
  "placeholders": [
    "name"
  ]
}

{
  "id": "507f1f77bcf86cd799439020",
  "key": "farewell",
  "title": {
    "defaultValue": "Happy birthday!",
    "langValues": {
      "ANY_ADDITIONAL_PROPERTY": "text"
    },
    "valid": true
  },
  "body": {
    "defaultValue": "Happy birthday!",
    "langValues": {
      "ANY_ADDITIONAL_PROPERTY": "text"
    },
    "valid": true
  },
  "resume": {
    "defaultValue": "Happy birthday!",
    "langValues": {
      "ANY_ADDITIONAL_PROPERTY": "text"
    },
    "valid": true
  },
  "category": "life-events",
  "coverImageURL": "text",
  "order": 1,
  "enabled": true,
  "placeholders": [
    "name"
  ]
}

List all templates for management

get

Returns every template of the global catalog, including disabled ones, for admin management. Ordered by order ascending.

Authorizations

SessionIdstringRequired

SessionId

Responses

200

All templates, including disabled ones

*/*

Global reusable announcement template shared by all companies (e.g. "See you later {name}!"). Placeholder tokens are stored verbatim.

idstringRead-onlyOptional

Unique template identifier

Example: 507f1f77bcf86cd799439020

keystringRequired

Stable business key / slug identifying the template

Example: farewell

categorystringOptional

Grouping shown in the dashboard template picker

Example: life-events

coverImageURLstringOptional

Cover/illustration image URL associated with the template

orderinteger · int32Optional

Display ordering within the catalog (ascending)

Example: 1

enabledbooleanOptional

Whether the template is offered to authors; disabled templates are hidden from the picker

Example: true

placeholdersstring[]Optional

Placeholder tokens the template exposes, for the dashboard token palette

Example: ["name"]

get/api/v1/company/announcements/templates/all

GET /api/v1/company/announcements/templates/all HTTP/1.1
Host: api.happyforce.com
SessionId: YOUR_API_KEY
Accept: */*

200

All templates, including disabled ones

[
  {
    "id": "507f1f77bcf86cd799439020",
    "key": "farewell",
    "title": {
      "defaultValue": "Happy birthday!",
      "langValues": {
        "ANY_ADDITIONAL_PROPERTY": "text"
      },
      "valid": true
    },
    "body": {
      "defaultValue": "Happy birthday!",
      "langValues": {
        "ANY_ADDITIONAL_PROPERTY": "text"
      },
      "valid": true
    },
    "resume": {
      "defaultValue": "Happy birthday!",
      "langValues": {
        "ANY_ADDITIONAL_PROPERTY": "text"
      },
      "valid": true
    },
    "category": "life-events",
    "coverImageURL": "text",
    "order": 1,
    "enabled": true,
    "placeholders": [
      "name"
    ]
  }
]