Update Contact Details

patch/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

accountIdstringrequired
AccountId for the contact details

Body application/json

emailobject
- emailAddressstringrequired
  Email address
phoneobject
- phoneNumberstringrequired
  Phone number

Response

Successful operation.

Body application/json

emailobject
- accountIdstring
- createdAtstring<date-time>
- modifiedAtstring<date-time>
- emailAddressstringrequired
phoneobject
- accountIdstring
- createdAtstring<date-time>
- modifiedAtstring<date-time>
- phoneNumberstringrequired

Request fields are invalid.

Body application/json

statusCodeintegerrequired
statusNamestringrequired
errorCodestringrequired
errorsobject[]
Items
- messagestring
- pathstring
  The location of the invalid path param, query param or payload attribute.

API caller is not allowed to perform the action.

Body application/json

statusCodeintegerrequired
statusNamestringrequired
errorCodestringrequired
reasonstring

Example

Example Request

ServerAuthentication

curl 'https://api.immersve.com/api/accounts/{accountId}/contact-details' \
  --request PATCH \
  --header 'Authorization: Bearer <access-token>' \
  --header 'Content-Type: application/json' \
  --data '{
  "email": {
    "emailAddress": "joe@joecardholder.com"
  },
  "phone": {
    "phoneNumber": "+1234567890"
  }
}'

curl 'https://api.immersve.com/api/accounts/{accountId}/contact-details' \
  --request PATCH \
  --header 'Authorization: Bearer <access-token>' \
  --header 'X-Account-Id: <target-account>' \
  --header 'Content-Type: application/json' \
  --data '{
  "email": {
    "emailAddress": "joe@joecardholder.com"
  },
  "phone": {
    "phoneNumber": "+1234567890"
  }
}'

curl 'https://api.immersve.com/api/accounts/{accountId}/contact-details' \
  --request PATCH \
  --header 'X-Api-Key: <api-key>' \
  --header 'X-Api-Secret: <api-secret>' \
  --header 'Content-Type: application/json' \
  --data '{
  "email": {
    "emailAddress": "joe@joecardholder.com"
  },
  "phone": {
    "phoneNumber": "+1234567890"
  }
}'

curl 'https://api.immersve.com/api/accounts/{accountId}/contact-details' \
  --request PATCH \
  --header 'X-Api-Key: <api-key>' \
  --header 'X-Api-Secret: <api-secret>' \
  --header 'X-Account-Id: <target-account>' \
  --header 'Content-Type: application/json' \
  --data '{
  "email": {
    "emailAddress": "joe@joecardholder.com"
  },
  "phone": {
    "phoneNumber": "+1234567890"
  }
}'

curl 'https://test.immersve.com/api/accounts/{accountId}/contact-details' \
  --request PATCH \
  --header 'Authorization: Bearer <access-token>' \
  --header 'Content-Type: application/json' \
  --data '{
  "email": {
    "emailAddress": "joe@joecardholder.com"
  },
  "phone": {
    "phoneNumber": "+1234567890"
  }
}'

curl 'https://test.immersve.com/api/accounts/{accountId}/contact-details' \
  --request PATCH \
  --header 'Authorization: Bearer <access-token>' \
  --header 'X-Account-Id: <target-account>' \
  --header 'Content-Type: application/json' \
  --data '{
  "email": {
    "emailAddress": "joe@joecardholder.com"
  },
  "phone": {
    "phoneNumber": "+1234567890"
  }
}'

curl 'https://test.immersve.com/api/accounts/{accountId}/contact-details' \
  --request PATCH \
  --header 'X-Api-Key: <api-key>' \
  --header 'X-Api-Secret: <api-secret>' \
  --header 'Content-Type: application/json' \
  --data '{
  "email": {
    "emailAddress": "joe@joecardholder.com"
  },
  "phone": {
    "phoneNumber": "+1234567890"
  }
}'

curl 'https://test.immersve.com/api/accounts/{accountId}/contact-details' \
  --request PATCH \
  --header 'X-Api-Key: <api-key>' \
  --header 'X-Api-Secret: <api-secret>' \
  --header 'X-Account-Id: <target-account>' \
  --header 'Content-Type: application/json' \
  --data '{
  "email": {
    "emailAddress": "joe@joecardholder.com"
  },
  "phone": {
    "phoneNumber": "+1234567890"
  }
}'

Example Response

{
  "email": {
    "accountId": "9b7552cf9abab0f2efed72df6b3ce4bc",
    "createdAt": "2019-08-24T14:15:22Z",
    "modifiedAt": "2019-08-24T14:15:22Z",
    "emailAddress": "joe@joecardholder.com"
  },
  "phone": {
    "accountId": "9b7552cf9abab0f2efed72df6b3ce4bc",
    "createdAt": "2019-08-24T14:15:22Z",
    "modifiedAt": "2019-08-24T14:15:22Z",
    "phoneNumber": "+1234567890"
  }
}

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

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