Update the contacts for the given organisation

PUT 
/organisations/:OrganisationId/contacts/:ContactId

udpate a specific contact

Request

Path Parameters

OrganisationId OrganisationIdrequired

Possible values: non-empty and <= 40 characters, Value must match regular expression ^[^<>]*$

The organisation ID

ContactId ContactIdrequired

Possible values: <= 255 characters, Value must match regular expression ^[^<>]*$

The contact id

Header Parameters

x-fapi-auth-date string

Possible values: Value must match regular expression ^(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)$

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

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.

application/json

Body

required

Properties to update contacts

ContactType ContactType (string)required

Possible values: Value must match regular expression ^[^<>]*$

Default value: Business

The type of Contact, default contact type is Business.

FirstName string

Possible values: <= 255 characters, Value must match regular expression ^[^<>]*$

LastName string

Possible values: <= 255 characters, Value must match regular expression ^[^<>]*$

Department string

Possible values: <= 255 characters, Value must match regular expression ^[^<>]*$

EmailAddress stringrequired

Possible values: <= 255 characters, Value must match regular expression ^(([^<>()\[\]\\.,;:\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,}))$

PhoneNumber stringrequired

Possible values: non-empty and <= 18 characters, Value must match regular expression ^[^<>]*$

AddressLine1 string

Possible values: <= 255 characters, Value must match regular expression ^[^<>]*$

Address line 1

AddressLine2 string

Possible values: <= 255 characters, Value must match regular expression ^[^<>]*$

Address line 2

City string

Possible values: <= 255 characters, Value must match regular expression ^[^<>]*$

City

Postcode string

Possible values: <= 40 characters, Value must match regular expression ^[^<>]*$

Postcode

Country string

Possible values: <= 255 characters, Value must match regular expression ^[^<>]*$

Country

AdditionalInformation string

Possible values: <= 65535 characters, Value must match regular expression ^[^<>]*$

Any additional user information

PgpPublicKey string

Possible values: <= 65535 characters, Value must match regular expression ^[^<>]*$

A PGP Public Key in text form

Responses

200

A contact object

Response Headers

• x-fapi-interaction-id

  string

application/json

Schema

Schema

ContactId string

Possible values: Value must match regular expression ^[^<>]*$

Unique contact ID for the row.

OrganisationId OrganisationId (string)

Possible values: non-empty and <= 40 characters, Value must match regular expression ^[^<>]*$

Unique ID associated with the organisation

ContactType ContactType (string)

Possible values: Value must match regular expression ^[^<>]*$

Default value: Business

The type of Contact, default contact type is Business.

FirstName string

Possible values: <= 255 characters, Value must match regular expression ^[^<>]*$

LastName string

Possible values: <= 255 characters, Value must match regular expression ^[^<>]*$

Department string

Possible values: <= 255 characters, Value must match regular expression ^[^<>]*$

EmailAddress string

Possible values: <= 255 characters, Value must match regular expression ^(([^<>()\[\]\\.,;:\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,}))$

PhoneNumber string

Possible values: <= 18 characters, Value must match regular expression ^[^<>]*$

AddressLine1 string

Possible values: <= 255 characters, Value must match regular expression ^[^<>]*$

Address line 1

AddressLine2 string

Possible values: <= 255 characters, Value must match regular expression ^[^<>]*$

Address line 2

City string

Possible values: <= 255 characters, Value must match regular expression ^[^<>]*$

City

Postcode string

Possible values: <= 40 characters, Value must match regular expression ^[^<>]*$

Postcode

Country string

Possible values: <= 255 characters, Value must match regular expression ^[^<>]*$

Country

AdditionalInformation string

Possible values: <= 65535 characters, Value must match regular expression ^[^<>]*$

Any additional user information

PgpPublicKey string

Possible values: <= 65535 characters, Value must match regular expression ^[^<>]*$

A PGP Public Key in text form

Example (from schema)

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

400

Bad Request

Response Headers

• x-fapi-interaction-id

  string

application/json

Schema

Schema

errors string[]

Validation Error messages

Example (from schema)

{
  "errors": [
    "string"
  ]
}

401

Unauthorized

Response Headers

• x-fapi-interaction-id

  string

403

Forbidden

Response Headers

• x-fapi-interaction-id

  string

404

Not found

Response Headers

• x-fapi-interaction-id

  string

application/json

Schema

Schema

errors string[]

Validation Error messages

Example (from schema)

{
  "errors": [
    "string"
  ]
}

406

Not Acceptable

Response Headers

• x-fapi-interaction-id

  string

429

Too many requests, maximum capacity reached. Requests are now throttled.

Response Headers

• x-fapi-interaction-id

  string

500

Internal Server Error

Response Headers

• x-fapi-interaction-id

  string

502

Bad Gateway

Response Headers

• x-fapi-interaction-id

  string

504

Upstream timeout, insufficient capacity to serve request. More capacity being brought online. Please try again.

Response Headers

• x-fapi-interaction-id

  string

Loading...