Skip to main content
POST
/
companies
/
v2
/
rs
/
{companyId}
/
contacts
Create contacts
curl --request POST \
  --url https://z52mnqg347.execute-api.eu-west-3.amazonaws.com/main/companies/v2/rs/{companyId}/contacts \
  --header 'Authorization: Bearer <token>' \
  --header 'content-type: <content-type>' \
  --header 'x-session-token: <x-session-token>' \
  --data '
[
  {
    "name": "Company Contact Name",
    "notify": true,
    "email": "example@email.com",
    "phones": [
      "phone1",
      "phone2"
    ],
    "comment": "Company contact comment"
  }
]
'
{
  "nbInsertion": 1
}

Authorizations

​
Authorization
string
header
required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Headers

​
x-session-token
string
required

Session token used for authenticating the request.

Example:

"eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJ1c2VySWQiOiIxMjM0NTY3ODkwIiwic2Vzc2lvbklkIjoiYWJjZGVmMTIzNDU2IiwiaWF0IjoxNjA1MDk3ODk5LCJleHAiOjE2MDUxODQyOTl9.4XRQ1iXDyvEj5LgPZHbmTmzOZs98M3YPOzgf3MhxjaI"

​
content-type
string
required

Content type, must be "application/json".

Allowed value: "application/json"

Body

application/json
​
name
string
required

Name of the company contact.

Maximum string length: 250
Example:

"Company Contact Name"

​
notify
boolean
required

Indicates whether the company contact should be notified.

Example:

true

​
email
string<email> · null · null

Email of the company contact.

Maximum string length: 250
Pattern: ^(?!\.)(?!.*\.\.)([A-Za-z0-9_'+\-\.]*)[A-Za-z0-9_+-]@([A-Za-z0-9][A-Za-z0-9\-]*\.)+[A-Za-z]{2,}$
Example:

"example@email.com"

​
phones
string[]

Phones of the company contact.

Maximum array length: 5
Maximum string length: 50
Example:
["phone1", "phone2"]
​
comment
string | null

Comment on the company contact.

Maximum string length: 2500
Example:

"Company contact comment"

Response

201 - application/json

Contacts created successfully

​
nbInsertion
integer
required

The number of inserted elements.

Required range: -9007199254740991 <= x <= 9007199254740991
Example:

1