The contactId in the data is ignored.

Authorization

A valid JWT is required to access this method.

Request

POST https://dev.medrecord.nl/profile/{mvUid}/relation/{relationId}/contact

Path parameters

Parameter name Value Description Additional
mvUid string

The ID of the user

Required
relationId string

The ID of the relation

Required

Request body

The request body takes a complete Contact information resource, containing the following writable properties:

{
    "availability": "enum",
    "label": "string",
    "note": "html",
    "primary": "boolean",
    "type": "enum",
    "usage": "enum",
    "value": "string"
}

Properties

Name Type Description Additional
availability enum

Availability

Possible values are:

  • BUSINESS_HOURS
  • EVENING
  • NIGHTTIME
  • DAYTIME
optional
label string

Label

optional
note html

Note

optional
primary boolean

Primary means of contact

required
type enum

Type

Possible values are:

  • SKYPE
  • PHONE
  • FAX
  • EMAIL
  • MOBILE
required
usage enum

Intended usage

Possible values are:

  • WORK
  • HOME
optional
value string

Value

required

Response

The following HTTP status codes may be returned, optionally with a response resource.

Status code Description Resource
200 OK

Success

Contact information

Explore this API

mvUid

The ID of the user

relationId

The ID of the relation

body
Request Content-Type
Response Content-Type

Authorisation:

authToken JWT to be used for request.
Try it out!
pluslistarrow-leftglobe