Browse the 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.
Tools
List the templates of the account, the structures its records are described by.
-
pageintegeroptional - The page to read, starting at 1.
-
per_pageintegeroptional - 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.
-
templatestringrequired - 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.
-
templatestringrequired - The id of the template, as list-templates gives it.
-
pageintegeroptional - The page to read, starting at 1.
-
per_pageintegeroptional - 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.
-
templatestringrequired - The id of the template, as list-templates gives it.
-
versionintegerrequired - 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.
-
pageintegeroptional - The page to read, starting at 1.
-
per_pageintegeroptional - 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.
-
namestringrequired - The name of the template.
-
applies_tostringrequired -
What the template describes.
One of:
contact,entity,life_event -
descriptionstringoptional - A sentence saying what the template is for.
-
entity_type_idstringoptional - 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.
-
templatestringrequired - The id of the template, as list-templates gives it.
-
namestringoptional - The new name.
-
descriptionstringoptional - The new description.
Copy a template into a new one, as a starting point. The change is written to the account log.
-
templatestringrequired - The id of the template, as list-templates gives it.
-
namestringoptional - The name of the copy. Made from the name of the original when left out.
-
slugstringoptional - 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.
-
templatestringrequired - The id of the template, as list-templates gives it.
-
is_activebooleanrequired - 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.
-
templatestringrequired - The id of the template, as list-templates gives it.
-
positionintegerrequired - 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.
-
templatestringrequired - 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.
-
templatestringrequired - 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.
-
templatestringrequired - The id of the template, as list-templates gives it.
-
versionintegerrequired - The number of the draft to publish, as list-template-versions gives it.
-
change_notestringoptional - 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.
-
templatestringrequired - The id of the template, as list-templates gives it.
-
versionintegerrequired - 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.
-
templatestringrequired - The id of the template, as list-templates gives it.
-
versionintegerrequired - The number of the draft, as create-template-draft gives it.
-
namestringoptional - The name of a new section to create. Leave it out when giving section_id.
-
iconstringoptional -
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 -
colourstringoptional -
The colour of a new section. Only with name.
One of:
#3f5fd0,#4f8a49,#9a6a24,#9a3f2b,#6b4fa8,#2f7f86,#a8447a,#4a4a52 -
section_idstringoptional - 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_numberintegeroptional - Which version of the section named by section_id to place. Only with section_id. The published one when left out.
-
page_idstringoptional - The id of the page to place the section on, as get-template-version gives it. The first page when left out.
-
title_overridestringoptional - What to head the section with in this template. Its own name when left out.
-
is_collapsed_by_defaultbooleanoptional - 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.
-
templatestringrequired - The id of the template, as list-templates gives it.
-
versionintegerrequired - The number of the draft, as create-template-draft gives it.
-
sectionstringrequired - The id of the section in that version, as get-template-version gives it.
-
title_overridestringoptional - What to head the section with in this template. Null goes back to the name of the section.
-
is_collapsed_by_defaultbooleanoptional - 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.
-
templatestringrequired - The id of the template, as list-templates gives it.
-
versionintegerrequired - The number of the draft, as create-template-draft gives it.
-
sectionstringrequired - 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.
-
templatestringrequired - The id of the template, as list-templates gives it.
-
versionintegerrequired - The number of the draft, as create-template-draft gives it.
-
sectionstringrequired - The id of the section in that version, as get-template-version gives it.
-
positionintegerrequired - 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.
-
templatestringrequired - The id of the template, as list-templates gives it.
-
versionintegerrequired - The number of the draft, as create-template-draft gives it.
-
sectionstringrequired - The id of the section in that version, as get-template-version gives it.
-
typestringrequired -
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 -
labelstringrequired - What the field is called on screen.
-
keystringoptional - A stable machine name for the field. Made from the label when left out.
-
value_list_idintegeroptional - The id of the value list a field offering choices takes them from, as list-value-lists gives it.
-
relation_targetstringoptional -
What a relation field points at.
One of:
contact,entity -
relation_entity_type_idstringoptional - The id of the kind of entity a relation field points at, as list-entity-types gives it.
-
parent_idintegeroptional - 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.
-
templatestringrequired - The id of the template, as list-templates gives it.
-
versionintegerrequired - The number of the draft, as create-template-draft gives it.
-
sectionstringrequired - The id of the section in that version, as get-template-version gives it.
-
fieldstringrequired - The id of the field, as get-template-version gives it.
-
labelstringoptional - What the field is called on screen.
-
help_textstringoptional - A line explaining the field, shown under it.
-
placeholderstringoptional - The example shown in the empty field.
-
is_requiredbooleanoptional - Whether a record cannot be saved without a value in this field.
-
is_sensitivebooleanoptional - Whether the value is hidden until asked for.
-
is_highlightedbooleanoptional - Whether the field is shown at the top of the record.
-
is_uniquebooleanoptional - Whether two records may not share a value.
-
is_identifyingbooleanoptional - Whether the field helps tell records apart.
-
value_list_idintegeroptional - The id of the value list a field offering choices takes them from, as list-value-lists gives it.
-
default_valueobjectoptional - The value a new record starts with.
-
optionsobjectoptional - Settings of the field type, such as the kinds of file accepted.
-
validationobjectoptional - Limits on the value, such as a minimum or a maximum.
-
repeat_minintegeroptional - The fewest values a repeatable field holds.
-
repeat_maxintegeroptional - The most values a repeatable field holds.
-
repetition_orderstringoptional -
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.
-
templatestringrequired - The id of the template, as list-templates gives it.
-
versionintegerrequired - The number of the draft, as create-template-draft gives it.
-
sectionstringrequired - The id of the section in that version, as get-template-version gives it.
-
fieldstringrequired - 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.
-
templatestringrequired - The id of the template, as list-templates gives it.
-
versionintegerrequired - The number of the draft, as create-template-draft gives it.
-
sectionstringrequired - The id of the section in that version, as get-template-version gives it.
-
fieldstringrequired - The id of the field, as get-template-version gives it.
-
positionintegerrequired - Where the field goes in its section, counting from 1.