Skip to main content

POST /contact-details/v1/{mpid}

Submits new or amended contact details for one MPAN.

Request

Method and path:

  • POST /contact-details/v1/{mpid}

Headers:

  • X-API-KEY (required): string, API key in UUID format.
  • X-IDEMPOTENCY-KEY (required): string.
  • X-TEST-MODE (optional): string, set to true to suppress production communications.

Path parameters:

  • mpid (required): string supplier MPID.

Body schema:

  • Contact details request object
{
"mpan_core": 1234567890123,
"customers": [
{
"customer_name": "Jane Smith",
"additional_information": "Prefers SMS after 6pm",
"customer_password": "BLUE10",
"customer_password_efd": "2026-03-20",
"special_access": "Rear gate access",
"max_power_req": 120,
"delete_address_data": false,
"mailing_address_1": "Flat 1",
"mailing_address_2": "10 High Street",
"mailing_address_3": null,
"mailing_address_4": null,
"mailing_address_5": null,
"mailing_address_6": null,
"mailing_address_7": null,
"mailing_address_8": null,
"mailing_address_9": null,
"mailing_address_postcode": "AB1 2CD",
"contacts": [
{
"contact_name": "Jane Smith",
"preferred_contact_method": "E",
"telephones": [
{
"telephone_number": "+447539294787",
"fax_number": null
}
],
"emails": [
{
"email_address": "jane.smith@example.com"
}
]
}
]
}
]
}

Response

Success:

  • 202 Accepted
  • Body: supplier process response object
{
"request_id": "72f30f06-afcc-4ad8-8c1f-78e556ea9cbc",
"request_type": "contact-details-update",
"request_status": "Pending",
"description": "Contact Details Update Process",
"created_at": "2026-03-11T14:04:22+00:00",
"last_updated_at": "2026-03-11T14:04:22+00:00",
"mpan_core": 1234567890123
}

Other documented responses:

  • 401 Unauthorized
  • 422 Validation error
  • 428 Missing X-IDEMPOTENCY-KEY

Field-level constraints: