MCP 207 tools

Browse the tools
Available tools

Templates

A template is the shape of a contact’s page: its pages, sections and fields. It changes through a draft and is published in versions.

Choose a tool to see the parameters it accepts.

Tools

List the templates of the account, the structures its records are described by.

page integer optional
The page to read, starting at 1.
per_page integer optional
How many templates a page holds: 25 unless asked, 100 at most.

Read one template of the account: its name, what it describes, whether it is active and which version is published.

template string required
The id of the template, as list-templates gives it.

List the versions of one template, so a caller can tell a draft from what is published.

template string required
The id of the template, as list-templates gives it.
page integer optional
The page to read, starting at 1.
per_page integer optional
How many versions a page holds: 25 unless asked, 100 at most.

Read one version of a template with its pages, the sections on each page and the fields of each section. The section and field ids the other template tools take come from here.

template string required
The id of the template, as list-templates gives it.
version integer required
The version number, as list-template-versions gives it.

List the value lists of the account, the named sets of choices a template field can offer, such as genders or phone labels, each with its choices in order. The id of a list is what create-template-field and update-template-field take as value_list_id.

page integer optional
The page to read, starting at 1.
per_page integer optional
How many lists a page holds: 25 unless asked, 100 at most.

Create a template for contacts, for a kind of entity or for life events. It starts with a first draft. The change is written to the account log.

name string required
The name of the template.
applies_to string required
What the template describes. One of: contact, entity, life_event
description string optional
A sentence saying what the template is for.
entity_type_id string optional
The id of the kind of entity the template describes, as list-entity-types gives it. Required when applies_to is entity.

Rename a template or change its description. The change is written to the account log.

template string required
The id of the template, as list-templates gives it.
name string optional
The new name.
description string optional
The new description.

Copy a template into a new one, as a starting point. The change is written to the account log.

template string required
The id of the template, as list-templates gives it.
name string optional
The name of the copy. Made from the name of the original when left out.
slug string optional
The short name of the copy. Made from the name of the copy when left out.

Switch a template on, so it is offered for new records, or off. The change is written to the account log.

template string required
The id of the template, as list-templates gives it.
is_active boolean required
True to switch the template on, false to switch it off.

Move a template to another place in the list of templates. The change is written to the account log.

template string required
The id of the template, as list-templates gives it.
position integer required
Where the template goes in the list, counting from 1.

Delete a template and all its versions. A template still describing records is refused. The change is written to the account log.

template string required
The id of the template, as list-templates gives it.

Open a draft of a template, the only kind of version whose sections and fields can change. When a draft is already open, it is returned instead of a second one.

template string required
The id of the template, as list-templates gives it.

Publish a draft of a template, so the records it describes start using it. The change is written to the account log.

template string required
The id of the template, as list-templates gives it.
version integer required
The number of the draft to publish, as list-template-versions gives it.
change_note string optional
What changed. Required from the second published version on.

Delete a draft of a template and every change made in it. A published version cannot be deleted. The change is written to the account log.

template string required
The id of the template, as list-templates gives it.
version integer required
The number of the draft to delete, as list-template-versions gives it.

Add a section to a draft of a template: give name to create a new section, or section_id to place one the account already has. The change is written to the account log.

template string required
The id of the template, as list-templates gives it.
version integer required
The number of the draft, as create-template-draft gives it.
name string optional
The name of a new section to create. Leave it out when giving section_id.
icon string optional
The icon of a new section. Only with name. One of: profile, people, note, relationship, family, timeline, calendar, reminder, tasks, memory, journal, file, mail, phone, place, home, briefcase, organization, graduation, health, activity, ball, food, gift, pet, plane, globe, book, music, coin, car, target, tag, heart, star, lock, layers
colour string optional
The colour of a new section. Only with name. One of: #3f5fd0, #4f8a49, #9a6a24, #9a3f2b, #6b4fa8, #2f7f86, #a8447a, #4a4a52
section_id string optional
The id of a section the account already has, as get-template-version shows it on another template. Leave it out when giving name.
section_version_number integer optional
Which version of the section named by section_id to place. Only with section_id. The published one when left out.
page_id string optional
The id of the page to place the section on, as get-template-version gives it. The first page when left out.
title_override string optional
What to head the section with in this template. Its own name when left out.
is_collapsed_by_default boolean optional
Whether the section starts folded shut.

Change what a section is headed in a draft of a template and whether it starts folded shut. The change is written to the account log.

template string required
The id of the template, as list-templates gives it.
version integer required
The number of the draft, as create-template-draft gives it.
section string required
The id of the section in that version, as get-template-version gives it.
title_override string optional
What to head the section with in this template. Null goes back to the name of the section.
is_collapsed_by_default boolean optional
Whether the section starts folded shut.

Remove a section from a draft of a template. The section itself stays in the account for the other templates using it. The change is written to the account log.

template string required
The id of the template, as list-templates gives it.
version integer required
The number of the draft, as create-template-draft gives it.
section string required
The id of the section in that version, as get-template-version gives it.

Move a section to another place on its page, in a draft of a template. The change is written to the account log.

template string required
The id of the template, as list-templates gives it.
version integer required
The number of the draft, as create-template-draft gives it.
section string required
The id of the section in that version, as get-template-version gives it.
position integer required
Where the section goes on its page, counting from 1.

Add a field to a section of a draft of a template. A section shared with other templates is drafted first, so its fields may come back with new ids. The change is written to the account log.

template string required
The id of the template, as list-templates gives it.
version integer required
The number of the draft, as create-template-draft gives it.
section string required
The id of the section in that version, as get-template-version gives it.
type string required
The kind of field. One of: text, textarea, number, boolean, url, email, phone, select, multiselect, radio, date, recurring_date, duration, relation, file, image, avatar, address, repeater, divider, heading, help
label string required
What the field is called on screen.
key string optional
A stable machine name for the field. Made from the label when left out.
value_list_id integer optional
The id of the value list a field offering choices takes them from, as list-value-lists gives it.
relation_target string optional
What a relation field points at. One of: contact, entity
relation_entity_type_id string optional
The id of the kind of entity a relation field points at, as list-entity-types gives it.
parent_id integer optional
The id of the repeater field to put this field inside, as get-template-version gives it.

Change a field of a section in a draft of a template. The field may come back with a new id: use the returned one afterwards. The change is written to the account log.

template string required
The id of the template, as list-templates gives it.
version integer required
The number of the draft, as create-template-draft gives it.
section string required
The id of the section in that version, as get-template-version gives it.
field string required
The id of the field, as get-template-version gives it.
label string optional
What the field is called on screen.
help_text string optional
A line explaining the field, shown under it.
placeholder string optional
The example shown in the empty field.
is_required boolean optional
Whether a record cannot be saved without a value in this field.
is_sensitive boolean optional
Whether the value is hidden until asked for.
is_highlighted boolean optional
Whether the field is shown at the top of the record.
is_unique boolean optional
Whether two records may not share a value.
is_identifying boolean optional
Whether the field helps tell records apart.
value_list_id integer optional
The id of the value list a field offering choices takes them from, as list-value-lists gives it.
default_value object optional
The value a new record starts with.
options object optional
Settings of the field type, such as the kinds of file accepted.
validation object optional
Limits on the value, such as a minimum or a maximum.
repeat_min integer optional
The fewest values a repeatable field holds.
repeat_max integer optional
The most values a repeatable field holds.
repetition_order string optional
How repeated values are ordered. One of: newest_last, newest_first

Delete a field from a section of a draft of a template. The change is written to the account log.

template string required
The id of the template, as list-templates gives it.
version integer required
The number of the draft, as create-template-draft gives it.
section string required
The id of the section in that version, as get-template-version gives it.
field string required
The id of the field, as get-template-version gives it.

Move a field to another place in its section, in a draft of a template. The field may come back with a new id: use the returned one afterwards. The change is written to the account log.

template string required
The id of the template, as list-templates gives it.
version integer required
The number of the draft, as create-template-draft gives it.
section string required
The id of the section in that version, as get-template-version gives it.
field string required
The id of the field, as get-template-version gives it.
position integer required
Where the field goes in its section, counting from 1.