Sign in

v1

latestOpenAPI 3.0.32026-08-0623677345.2 KB
Billing

Create contact

post/contacts/

Headers

x-simple-workspacestring required

Workspace (account) identifier. Required for every request.

x-piriod-test-modeboolean

Whether to operate against test-mode data. Defaults to false.

Request body

customerstring nullable
orgunitstring nullable
namestring required
emailstring email required
phonestring nullable
invoicingboolean
collectionsboolean

Response

Contact created.

idstring
customerstring nullable

Customer ID this contact belongs to.

orgunitstring nullable

Organisation unit ID. Optional sub-grouping inside a customer.

namestring required
emailstring email required
phonestring nullable
invoicingboolean

Whether this contact receives invoice emails.

collectionsboolean

Whether this contact receives collection reminders.

createdstring date-time
updatedstring date-time

Example response

{
  "id": "con_01H8XYZ123ABC"
}