Sign in

v1

latestOpenAPI 3.0.02026-07-24115101.2 MB
Contact

Create a contact

Use this endpoint to create a new contact within the selected workspace.

post/contacts

Headers

x-oneflow-api-tokenstring required

The API key of your Oneflow account.

x-oneflow-user-emailstring email required

The email address of a registered Oneflow user.

Request body

company_namestring

The name of the contact person's company.

company_registration_numberstring

The registration number of the contact person's company.

country_codestring country_code

The country code of the contact.

date_of_birthstring

The date of birth of the contact person.

emailstring email required

The email of the contact person.

namestring required

The name of the contact person.

notesstring

The notes add by the contact person.

phone_numberstring nullable

The phone number of the contact person.

titlestring

The title of the contact person.

workspace_idinteger required

The unique ID of the workspace.

Example request

{
  "company_name": "Company AB",
  "email": "own@email.com",
  "name": "Firstname Lastname",
  "workspace_id": 130001
}

Response

Returns the created contact.

company_namestring required
company_registration_numberstring required
country_codestring required
created_timestring datetime nullable required
date_of_birthstring required
emailstring email required
idinteger required
namestring required
notesstring required
phone_numberstring nullable required
titlestring required
updated_timestring datetime nullable required
workspace_idinteger required