Creating one or more contact persons¶

Note

This request is only available to administrators of the root group of the organisation.

Sends a POST request to the endpoint /organization/contacts.

Description¶

The Create-Organization-Contacts request creates one or more contact persons for the organisation.

Requirements¶

Values of the request: none Objects: OrganizationContactVO

Request¶

To create contact persons, send a POST request to the endpoint. Unlike most other create requests, the body is not a single object but a simple JSON array with one or more OrganizationContactVO objects, for example [{...}, {...}]. Each object must not contain the attribute id and must define the following attributes:

Attributes	Description	Values
`email`	The email address of the contact person.	`string`
`receiveSSLReminders`	Defines whether the contact person gets notifications about expiring certificates.	`true` `false`

The following attributes are optional:

Attributes	Description	Values
`userId`	The ID of the user linked to this entry, if the contact person is a user of the Myra App.	`integer`
`name`	The name of the contact person.	`string`
`phone`	The phone number of the contact person.	`string`
`technicalPriority`	Defines the priority of the contact person for technical issues.	`integer` (1-6)
`escalationPriority`	Defines the priority of the contact person for escalations.	`integer` (1-6)

The system returns the created OrganizationContactVO objects, each extended by the server-set attributes id, created, and modified. Each created contact person is automatically linked to the organisation of the authenticated user; the object provides no attribute to set the organisation explicitly.

Example¶

Example request body:

[
  {
    "userId": 123,
    "name": "Jane Doe",
    "email": "jane.doe@example.com",
    "phone": "+49 30 1234567",
    "receiveSSLReminders": true,
    "technicalPriority": 1,
    "escalationPriority": 1
  }
]

Responses¶

The following responses are available:

STATUS CODE	DESCRIPTION
201	The request has succeeded and a new object has been created.
400	The request was unsuccessful. The request was invalid or information is missing.
401	The request has not succeeded because the user authentication was incorrect.
403	The request has not succeeded because the user does not have the right permissions.