Update the contacts for the given organisation

PUT /organisations/{OrganisationId}/contacts/{ContactId}

O auth

Headers

x-fapi-auth-date string

The time when the PSU last logged in with the TPP. All dates in the HTTP headers are represented as RFC 7231 Full Dates. An example is below: Sun, 10 Sep 2017 19:43:31 UTC

Format should match the following pattern: ^(Mon|Tue|Wed|Thu|Fri|Sat|Sun), \d{2} (Jan|Feb|Mar|Apr|May|Jun|Jul|Aug|Sep|Oct|Nov|Dec) \d{4} \d{2}:\d{2}:\d{2} (GMT|UTC)$.
x-fapi-customer-ip-address string

The PSU's IP address if the PSU is currently logged in with the TPP.
x-fapi-interaction-id string

An RFC4122 UID used as a correlation id.
x-customer-user-agent string

Indicates the user-agent that the PSU is using.

Path parameters

OrganisationId string Required

The organisation ID

Minimum length is 1, maximum length is 40. Format should match the following pattern: ^[^<>]*$.
ContactId string

The contact id

Maximum length is 255. Format should match the following pattern: ^[^<>]*$.

application/json

Body Required

AdditionalInformation string

Any additional user information

Maximum length is 65535. Format should match the following pattern: ^[^<>]*$.
AddressLine1 string

Address line 1

Maximum length is 255. Format should match the following pattern: ^[^<>]*$.
AddressLine2 string

Address line 2

Maximum length is 255. Format should match the following pattern: ^[^<>]*$.
City string

City

Maximum length is 255. Format should match the following pattern: ^[^<>]*$.
ContactType string Required

The type of Contact, default contact type is Business.

Maximum length is 255. Format should match the following pattern: ^[^<>]*$. Default value is Business.
Country string

Country

Maximum length is 255. Format should match the following pattern: ^[^<>]*$.
Department string

Maximum length is 255. Format should match the following pattern: ^[^<>]*$.
EmailAddress string Required

Maximum length is 255. Format should match the following pattern: ^(([^<>()\[\]\\.,;:\s@"]+(\.[^<>()\[\]\\.,;:\s@"]+)*)|(".+"))@((\[[0-9]{1,3}\.[0-9]{1,3}\.[0-9]{1,3}\.[0-9]{1,3}\])|(([a-zA-Z\-0-9]+\.)+[a-zA-Z]{2,}))$.
FirstName string

Maximum length is 255. Format should match the following pattern: ^[^<>]*$.
LastName string

Maximum length is 255. Format should match the following pattern: ^[^<>]*$.
PgpPublicKey string

A PGP Public Key in text form

Maximum length is 65535. Format should match the following pattern: ^[^<>]*$.
PhoneNumber string Required

Minimum length is 1, maximum length is 18. Format should match the following pattern: ^[^<>]*$.
Postcode string

Postcode

Maximum length is 40. Format should match the following pattern: ^[^<>]*$.

Responses

200 application/json

A contact object
Hide headers attribute Show headers attribute
- x-fapi-interaction-id string
  
  An RFC4122 UID used as a correlation id.
  
  Minimum length is 1, maximum length is 100. Format should match the following pattern: ^[a-zA-Z0-9][a-zA-Z0-9\-]{0,99}$.
Hide response attributes Show response attributes object
- AdditionalInformation string
  
  Any additional user information
  
  Maximum length is 65535. Format should match the following pattern: ^[^<>]*$.
- AddressLine1 string
  
  Address line 1
  
  Maximum length is 255. Format should match the following pattern: ^[^<>]*$.
- AddressLine2 string
  
  Address line 2
  
  Maximum length is 255. Format should match the following pattern: ^[^<>]*$.
- City string
  
  City
  
  Maximum length is 255. Format should match the following pattern: ^[^<>]*$.
- ContactId string
  
  Unique contact ID for the row.
  
  Format should match the following pattern: ^[^<>]*$.
- ContactType string
  
  The type of Contact, default contact type is Business.
  
  Maximum length is 255. Format should match the following pattern: ^[^<>]*$. Default value is Business.
- Country string
  
  Country
  
  Maximum length is 255. Format should match the following pattern: ^[^<>]*$.
- Department string
  
  Maximum length is 255. Format should match the following pattern: ^[^<>]*$.
- EmailAddress string
  
  Maximum length is 255. Format should match the following pattern: ^(([^<>()\[\]\\.,;:\s@"]+(\.[^<>()\[\]\\.,;:\s@"]+)*)|(".+"))@((\[[0-9]{1,3}\.[0-9]{1,3}\.[0-9]{1,3}\.[0-9]{1,3}\])|(([a-zA-Z\-0-9]+\.)+[a-zA-Z]{2,}))$.
- FirstName string
  
  Maximum length is 255. Format should match the following pattern: ^[^<>]*$.
- LastName string
  
  Maximum length is 255. Format should match the following pattern: ^[^<>]*$.
- OrganisationId string
  
  Unique ID associated with the organisation
  
  Minimum length is 1, maximum length is 40. Format should match the following pattern: ^[^<>]*$.
- PgpPublicKey string
  
  A PGP Public Key in text form
  
  Maximum length is 65535. Format should match the following pattern: ^[^<>]*$.
- PhoneNumber string
  
  Maximum length is 18. Format should match the following pattern: ^[^<>]*$.
- Postcode string
  
  Postcode
  
  Maximum length is 40. Format should match the following pattern: ^[^<>]*$.
400 application/json

Bad Request
Hide headers attribute Show headers attribute
- x-fapi-interaction-id string
  
  An RFC4122 UID used as a correlation id.
  
  Minimum length is 1, maximum length is 100. Format should match the following pattern: ^[a-zA-Z0-9][a-zA-Z0-9\-]{0,99}$.
Hide response attribute Show response attribute object
- errors array[string]
  
  Validation Error messages
401

Unauthorized
Hide headers attribute Show headers attribute
- x-fapi-interaction-id string
  
  An RFC4122 UID used as a correlation id.
  
  Minimum length is 1, maximum length is 100. Format should match the following pattern: ^[a-zA-Z0-9][a-zA-Z0-9\-]{0,99}$.
403

Forbidden
Hide headers attribute Show headers attribute
- x-fapi-interaction-id string
  
  An RFC4122 UID used as a correlation id.
  
  Minimum length is 1, maximum length is 100. Format should match the following pattern: ^[a-zA-Z0-9][a-zA-Z0-9\-]{0,99}$.
404 application/json

Not found
Hide headers attribute Show headers attribute
- x-fapi-interaction-id string
  
  An RFC4122 UID used as a correlation id.
  
  Minimum length is 1, maximum length is 100. Format should match the following pattern: ^[a-zA-Z0-9][a-zA-Z0-9\-]{0,99}$.
Hide response attribute Show response attribute object
- errors array[string]
  
  Validation Error messages
406

Not Acceptable
Hide headers attribute Show headers attribute
- x-fapi-interaction-id string
  
  An RFC4122 UID used as a correlation id.
  
  Minimum length is 1, maximum length is 100. Format should match the following pattern: ^[a-zA-Z0-9][a-zA-Z0-9\-]{0,99}$.
429

Too many requests, maximum capacity reached. Requests are now throttled.
Hide headers attribute Show headers attribute
- x-fapi-interaction-id string
  
  An RFC4122 UID used as a correlation id.
  
  Minimum length is 1, maximum length is 100. Format should match the following pattern: ^[a-zA-Z0-9][a-zA-Z0-9\-]{0,99}$.
500

Internal Server Error
Hide headers attribute Show headers attribute
- x-fapi-interaction-id string
  
  An RFC4122 UID used as a correlation id.
  
  Minimum length is 1, maximum length is 100. Format should match the following pattern: ^[a-zA-Z0-9][a-zA-Z0-9\-]{0,99}$.
502

Bad Gateway
Hide headers attribute Show headers attribute
- x-fapi-interaction-id string
  
  An RFC4122 UID used as a correlation id.
  
  Minimum length is 1, maximum length is 100. Format should match the following pattern: ^[a-zA-Z0-9][a-zA-Z0-9\-]{0,99}$.
504

Upstream timeout, insufficient capacity to serve request. More capacity being brought online. Please try again.
Hide headers attribute Show headers attribute
- x-fapi-interaction-id string
  
  An RFC4122 UID used as a correlation id.
  
  Minimum length is 1, maximum length is 100. Format should match the following pattern: ^[a-zA-Z0-9][a-zA-Z0-9\-]{0,99}$.

PUT /organisations/{OrganisationId}/contacts/{ContactId}

curl \
 --request PUT 'https://matls-api.sandbox.raidiam.io/organisations/{OrganisationId}/contacts/{ContactId}' \
 --header "Authorization: Bearer $ACCESS_TOKEN" \
 --header "Content-Type: application/json" \
 --header "x-fapi-auth-date: string" \
 --header "x-fapi-customer-ip-address: string" \
 --header "x-fapi-interaction-id: string" \
 --header "x-customer-user-agent: string" \
 --data '{"AdditionalInformation":"string","AddressLine1":"string","AddressLine2":"string","City":"string","ContactType":"Business","Country":"string","Department":"string","EmailAddress":"string","FirstName":"string","LastName":"string","PgpPublicKey":"string","PhoneNumber":"string","Postcode":"string"}'

Request examples

# Headers
x-fapi-auth-date: string
x-fapi-customer-ip-address: string
x-fapi-interaction-id: string
x-customer-user-agent: string

# Payload
{
  "AdditionalInformation": "string",
  "AddressLine1": "string",
  "AddressLine2": "string",
  "City": "string",
  "ContactType": "Business",
  "Country": "string",
  "Department": "string",
  "EmailAddress": "string",
  "FirstName": "string",
  "LastName": "string",
  "PgpPublicKey": "string",
  "PhoneNumber": "string",
  "Postcode": "string"
}

Response examples (200)

# Headers
x-fapi-interaction-id: 73cac523-d3ae-2289-b106-330a6218710d

# Payload
{
  "AdditionalInformation": "string",
  "AddressLine1": "string",
  "AddressLine2": "string",
  "City": "string",
  "ContactId": "string",
  "ContactType": "Business",
  "Country": "string",
  "Department": "string",
  "EmailAddress": "string",
  "FirstName": "string",
  "LastName": "string",
  "OrganisationId": "string",
  "PgpPublicKey": "string",
  "PhoneNumber": "string",
  "Postcode": "string"
}

Response examples (400)

# Headers
x-fapi-interaction-id: 73cac523-d3ae-2289-b106-330a6218710d

# Payload
{
  "errors": [
    "string"
  ]
}

Response examples (404)

# Headers
x-fapi-interaction-id: 73cac523-d3ae-2289-b106-330a6218710d

# Payload
{
  "errors": [
    "string"
  ]
}