create

POST

/public/contact/create

• Enclave API server

Create a contact inside the workspace.

Request Body ^required

object

workspaceUuid

required

The UUID of the workspace to create the envelope in.

string

>= 36 characters <= 36 characters

contacts

required

The contacts to create.

Array<object>

>= 1 items

object

email

required

The email of the contact.

string

<= 255 characters

firstname

required

The first name of the contact.

string

<= 128 characters

lastname

required

The last name of the contact.

string

<= 128 characters

phone

The phone number of the contact.

string

"" <= 32 characters

language

The language of the contact.

string

Allowed values: fr en

jobTitle

The job title of the contact.

string

<= 255 characters

company

The company of the contact.

string

<= 255 characters

addressLine1

The address line 1 of the contact.

string

<= 255 characters

addressLine2

The address line 2 of the contact.

string

<= 255 characters

zipCode

The zip code of the contact.

string

<= 32 characters

city

The city of the contact.

string

<= 128 characters

country

The country of the contact.

string

<= 128 characters

Responses

200

Default Response

object

contacts

required

The contacts created.

Array<object>

>= 1 items

object

uuid

required

The UUID of the contact.

string

email

required

The email of the contact.

string

firstname

required

The first name of the contact.

string

lastname

required

The last name of the contact.

string

phone

required

Any of:

string

string

null

null

language

The language of the contact.

string

Allowed values: fr en

jobTitle

The job title of the contact.

string

company

The company of the contact.

string

addressLine1

The address line 1 of the contact.

string

addressLine2

The address line 2 of the contact.

string

zipCode

The zip code of the contact.

string

city

The city of the contact.

string

country

The country of the contact.

string

400

Default Response

object

statusCode

required

HTTP status code

number

error

required

object

code

required

The error code

string

Allowed values: WORKSPACE_NOT_FOUND CONTACT_EMAIL_ALREADY_EXISTS INVALID_REQUEST_FORMAT

message

required

The error message

string

suggestion

required

A suggestion to resolve the error

string

documentationUrl

required

A URL to the documentation

string

requestId

required

The unique identifier of the request

string

timestamp

required

The timestamp of the response

string

path

required

The path of the request

string

401

Default Response

object

statusCode

required

HTTP status code

number

error

required

object

code

required

The error code

string

Allowed values: AUTHENTICATION_ERROR TUNNEL_ERROR INVALID_REQUEST_FORMAT

message

required

The error message

string

suggestion

required

A suggestion to resolve the error

string

documentationUrl

required

A URL to the documentation

string

requestId

required

The unique identifier of the request

string

timestamp

required

The timestamp of the response

string

path

required

The path of the request

string

403

Default Response

object

statusCode

required

HTTP status code

number

error

required

object

code

required

The error code

string

Allowed values: AUTHORIZATION_ERROR FEATURE_NOT_IN_CURRENT_PLAN INVALID_REQUEST_FORMAT

message

required

The error message

string

suggestion

required

A suggestion to resolve the error

string

documentationUrl

required

A URL to the documentation

string

requestId

required

The unique identifier of the request

string

timestamp

required

The timestamp of the response

string

path

required

The path of the request

string

500

Default Response

object

statusCode

required

HTTP status code

number

error

required

object

code

required

The error code

string

Allowed values: INTERNAL_SERVER_ERROR INVALID_REQUEST_FORMAT

message

required

The error message

string

suggestion

required

A suggestion to resolve the error

string

documentationUrl

required

A URL to the documentation

string

requestId

required

The unique identifier of the request

string

timestamp

required

The timestamp of the response

string

path

required

The path of the request

string