plnnrlydevelopers

Deze referentie is alleen in het Engels. Naar het Nederlandse REST API-overzicht

Diese Referenz gibt es nur auf Englisch. Zur deutschen REST-API-Übersicht

Cette référence existe uniquement en anglais. Aller à la présentation de l'API REST en français

Esta referencia solo está en inglés. Ir a la introducción de la API REST en español

Contact

Contact

A contact person: either a customer's contact (the CRM address book) or an employee's emergency contact, distinguished by contactable_type.

View as Markdown
Summary view
ContactList, 18 fields. What a list returns by default.
Detail view
Contact, 18 fields. The default for a single read and for every write.
Read with
api:read:customersandcustomers::read
Write with
api:write:customersandcustomers::create

Emergency contacts are personal data: they are visible and writable only to the employee they belong to, whatever the customers permission. Contacts are not soft-deleted, so deleting one is permanent.

Used by

GETList contacts/contactsContactList
POSTCreate a contact/contactsContact
GETRead a contact/contacts/{contact}Contact
PATCHUpdate a contact/contacts/{contact}Contact

Fields

Detail only
Only in the detail view.
Only with include
Only when you ask for it with include.
Server-assigned
Set by plnnrly, never by a request.
idinteger

Unique identifier.

contactable_typestring

The kind of record contactable points at; it says which branch of contactable applies.

customeruser

New values may be added.

contactable_idinteger

The id of the record contactable points at.

contactableRef or CustomerSummary or UserSummary

The record this contact belongs to: a customer for a CRM contact, a user for an employee's emergency contact. Rendered as {"id": N} until named in ?include=contactable, and still as {"id": N} where the caller may not read the parent's prefix. contactable_type and contactable_id are always present, so the parent can be found without the include, and the reference form shows nothing contactable_id does not.

Which form you get depends on contactable_type.

customer
CustomerSummary
user
UserSummary
contact_role_idinteger or null

Assigned contact role, or null. Deleting a role unassigns it rather than refusing.

roleRef or ContactRoleSummary or null

The contact's role. Rendered as {"id": N} until named in ?include=role, and null where no role is assigned.

namestring≤ 255

Contact name. This is the default sort key and one of the fields ?q= searches.

emailstring or null≤ 255

Email address. The second field ?q= searches; not unique.

phonestring or null≤ 255

Phone number.

addressstring or null≤ 255

Street address. plnnrly pre-fills this from the customer when adding a contact, but the API fills in no default for it.

Variants

ContactList 18 fields

What a collection returns, and what ?view=summary returns on a single record.

The same fields as the detail object.

ContactLinks 1 field

The links object on this resource.

Keys: self

Polymorphic fields

contactableWhich form you get depends on contactable_type.