Update Contact Details

PATCH 
https://api.immersve.com/api/accounts/:accountId/contact-details

This endpoint sets or updates the contact details (email and phone) for the account. The contact details are used to send notifications to the cardholder, such as for 3DSecure and one time passwords.

Request

Path Parameters

accountId stringrequired

AccountId for the contact details

application/json

Bodyrequired

email object
emailAddressstringrequired
Email address
Example: joe@joecardholder.com
phone object
phoneNumberstringrequired
Phone number
Example: +1234567890

Responses

200

application/json

Schema

Schema

email object
accountIdstringrequired
Example: 9b7552cf9abab0f2efed72df6b3ce4bc
createdAtstring<date-time>required
modifiedAtstring<date-time>required
emailAddressstringrequired
Example: joe@joecardholder.com
phone object
accountIdstringrequired
Example: 9b7552cf9abab0f2efed72df6b3ce4bc
createdAtstring<date-time>required
modifiedAtstring<date-time>required
phoneNumberstringrequired
Example: +1234567890

Example (auto)

{
  "email": {
    "accountId": "9b7552cf9abab0f2efed72df6b3ce4bc",
    "createdAt": "2024-07-29T15:51:28.071Z",
    "modifiedAt": "2024-07-29T15:51:28.071Z",
    "emailAddress": "joe@joecardholder.com"
  },
  "phone": {
    "accountId": "9b7552cf9abab0f2efed72df6b3ce4bc",
    "createdAt": "2024-07-29T15:51:28.071Z",
    "modifiedAt": "2024-07-29T15:51:28.071Z",
    "phoneNumber": "+1234567890"
  }
}

400

Request fields are invalid

application/json

Schema

Schema

statusCodeintegerrequired
Example: 400
statusNamestringrequired
Example: Bad Request
errorCodestringrequired
Example: INVALID_REQUEST_INPUT
errors object[]
Array [
messagestring
Example: Invalid type
pathstring
The location of the invalid path param, query param or payload attribute.
Example: items[1].attributes.invalidField
]

Example (auto)

{
  "statusCode": 400,
  "statusName": "Bad Request",
  "errorCode": "INVALID_REQUEST_INPUT",
  "errors": [
    {
      "message": "Invalid type",
      "path": "items[1].attributes.invalidField"
    }
  ]
}

403

API caller is not allowed to perform the action

application/json

Schema

Schema

statusCodeintegerrequired
Example: 403
statusNamestringrequired
Example: Forbidden
errorCodestringrequired
Example: FORBIDDEN
reasonstring
Example: Unauthorized

Example (auto)

{
  "statusCode": 403,
  "statusName": "Forbidden",
  "errorCode": "FORBIDDEN",
  "reason": "Unauthorized"
}

Authorization: http

name: Access Tokentype: httpscheme: bearerbearerFormat: JWT

• csharp
• curl
• dart
• go
• http
• java
• javascript
• kotlin
• c
• nodejs
• objective-c
• ocaml
• php
• powershell
• python
• r
• ruby
• rust
• shell
• swift

• HTTPCLIENT
• RESTSHARP

var client = new HttpClient();
var request = new HttpRequestMessage(HttpMethod.Patch, "https://api.immersve.com/api/accounts/:accountId/contact-details");
request.Headers.Add("Accept", "application/json");
request.Headers.Add("Authorization", "Bearer <token>");
var content = new StringContent("{\n  \"email\": {\n    \"emailAddress\": \"joe@joecardholder.com\"\n  },\n  \"phone\": {\n    \"phoneNumber\": \"+1234567890\"\n  }\n}", null, "application/json");
request.Content = content;
var response = await client.SendAsync(request);
response.EnsureSuccessStatusCode();
Console.WriteLine(await response.Content.ReadAsStringAsync());

Request Collapse all

Base URL

https://api.immersve.com

Auth

Security Scheme

Access TokenAccess Token and Target AccountApi Key and Api SecretApi Key and Api Secret and Target Account

Bearer Token

Parameters

accountId — pathrequired

Body required

{
  "email": {
    "emailAddress": "joe@joecardholder.com"
  },
  "phone": {
    "phoneNumber": "+1234567890"
  }
}

ResponseClear

Click the Send API Request button above and see the response here!