Skip to main content
POST
Create a contact
Contacts are the individuals at a buyer’s organization who receive automated email communications generated by Tilta – including invoice notifications, payment reminders, and overdue notices. Every buyer should have at least one contact so that payment-related communications reach the right person. You associate a contact with a specific buyer by providing the buyer_external_id in the request body. If you do not supply an external_id, Tilta automatically generates a UUID for the new contact.
A buyer must exist before you can create a contact for them. Ensure the referenced buyer_external_id corresponds to a buyer that has already been registered in Tilta.
Create at least one contact for every buyer immediately after the buyer is registered. Without a contact, Tilta cannot deliver invoice and payment reminder emails, which may lead to missed payments and delayed collections.

Authorizations

Authorization
string
header
required

Your Tilta API key, sent as Bearer <key>.

Body

application/json
buyer_external_id
string
required

External identifier of the buyer this contact belongs to.

Maximum string length: 100
Pattern: ^[a-zA-Z0-9-_]+$
salutation
enum<string> | null

Contact salutation.

Available options:
MR,
MS,
OTHER
first_name
string | null

Contact first name.

last_name
string | null

Contact last name.

email
string<email> | null

Contact email.

phone
string | null

Contact phone number. (+491711010101)

Example:

"+491711010101"

assign_to_all_invoices
boolean
default:true

Whether this contact should automatically be assigned to all invoices created for the buyer. Defaults to true.

address
object | null

Contact's address.

external_id
string | null

Unique identifier of the contact. If not provided, a UUID will be generated by the server. Must be unique per platform.

Maximum string length: 100
Pattern: ^[a-zA-Z0-9-_]+$

Response

Contact response payload.

external_id
string
required

Unique identifier of a contact.

Maximum string length: 100
Pattern: ^[a-zA-Z0-9-_]+$
buyer_external_id
string
required

External identifier of the buyer this contact belongs to.

Maximum string length: 100
Pattern: ^[a-zA-Z0-9-_]+$
assign_to_all_invoices
boolean
required

Whether this contact should automatically be assigned to all invoices created for the buyer.

created_at
number
required

Timestamp indicating when the contact was created (unix time in seconds).

Example:

1582896122

updated_at
number
required

Timestamp indicating the last time the contact was updated (unix time in seconds).

Example:

1582896122

salutation
enum<string> | null

Contact salutation.

Available options:
MR,
MS,
OTHER
first_name
string | null

Contact first name.

last_name
string | null

Contact last name.

email
string<email> | null

Contact email.

phone
string | null

Contact phone number in E.164 format (e.g. +491711010101).

Example:

"+491711010101"

address
object | null

Contact's address.