Send Email to Customer
POST /obp/v7.0.0/banks/BANK_ID/customers/CUSTOMER_ID/emails
OBPv7.0.0-sendEmailToCustomer Roles: CanSendEmailToCustomerAtOneBank(per bank) Customer
Queues a plain-text email to the Customer CUSTOMER_ID of BANK_ID, at the email address on the Customer record, for example to confirm that their application was received or to tell them a decision was made. The address is never returned. The message outbox sends the email and retries it until it is delivered.
The body has a subject (1 to 200 characters, one line), the text (1 to 20000 characters)
and an optional reference (at most 255 characters), for example the record the email is about,
kept with the queued message. A line saying which application sent the email is added to the text.
Limits. Only a Customer of BANK_ID is emailed, and not in a self-service bank (one made with Create My Bank),
where anyone could hold the Role and give Customers any address. At most customer_emails.max_per_customer_per_day (default 20)
emails are queued for a Customer in 24 hours, by all applications together. The From address is
customer_emails.sender_address, else mail.api.consumer.registered.sender.address.
Who may call it. A User with the Role CanSendEmailToCustomerAtOneBank at BANK_ID, or an application acting as itself whose Consumer holds it as a Scope.
Authentication is Required.
User Authentication is Required. The User must be logged in. The Application must also be authenticated.
This endpoint supports User XOR Application authorisation: either a person acting on their own Entitlements, or an Application acting as itself (e.g. with an OAuth2 client-credentials token) on its Consumer's Scopes. A person calling through a Consumer does not get that Consumer's Scopes. See here for more information.
This endpoint supports User XOR Application authorisation: either a person acting on their own Entitlements, or an Application acting as itself (e.g. with an OAuth2 client-credentials token) on its Consumer's Scopes. A person calling through a Consumer does not get that Consumer's Scopes. See here for more information.
This endpoint supports User XOR Application authorisation: either a person acting on their own Entitlements, or an Application acting as itself (e.g. with an OAuth2 client-credentials token) on its Consumer's Scopes. A person calling through a Consumer does not get that Consumer's Scopes. See here for more information.
URL Parameters:
BANK_ID: gh.29.uk
CUSTOMER_ID: 7uy8a7e4-6d02-40e3-a129-0b2bf89de8uh
JSON request body fields (3)
- subject
- subject
- text
- reference
- reference
JSON response body fields (7)
- bank_id
- gh.29.uk
- created_at
- created_at
- customer_id
- 7uy8a7e4-6d02-40e3-a129-0b2bf89de8uh
- message_id
- message_id
- status
- subject
- subject
- reference
- reference
Example request body
{
"subject": "Your application was received",
"text": "Dear applicant,\n\nThank you: your application to Cohort 1 was received on 20 November.",
"reference": "cohort_application:6fb17583-1e49-4435-bb74-a14fe0996723"
}Example success response
{
"message_id": "1042",
"bank_id": "cohort",
"customer_id": "7uy8a7e4-6d02-40e3-a129-0b2bf89de9f0",
"subject": "Your application was received",
"reference": "cohort_application:6fb17583-1e49-4435-bb74-a14fe0996723",
"status": "PENDING",
"created_at": "2026-11-18T11:06:40Z"
}Possible errors (11)
- OBP-30001: Bank not found. Please specify a valid value for BANK_ID.
- OBP-20001: User not logged in. Authentication is required!
- OBP-20006: User is missing one or more roles:
- OBP-10001: Incorrect json format.
- OBP-30605: Customers of a self-service bank cannot be emailed.
- OBP-30606: No From address is set for emails to Customers. Set the prop customer_emails.sender_address.
- OBP-30046: Customer not found. Please specify a valid value for CUSTOMER_ID.
- OBP-30607: The Customer has no usable email address.
- OBP-30608: Too many emails have been sent to this Customer today.
- OBP-50000: Unknown Error.
- OBP-20200: The application cannot be identified.