API Reference

Sign up for newsletters

post
https://{project_url}/webservice/rest-api/{api_interface}/{version}/customers/actions/newsletters-sign-up

Sign up a contact for the newsletter. The contact does not need to be an existing customer.
⚠️ We strongly recommend verifying the contact with CAPTCHA before sending a request to CareCloud API.

Partner assignment

When a contact is signed up, CareCloud creates one or more customer-partner relations. The assignment is determined as follows:

  • If partner_records is provided (non-empty array) - relations are created for exactly those partners.
  • If partner_records is an empty array ([]) or omitted - relations are created for all partners accessible to the authenticated API user.

Because this endpoint returns no customer ID, partner assignment cannot be managed after the call. Use partner_records to control assignment at sign-up time.

Body Params
string
required

The parameter could contain email, phone number or other identifier of the contact.

string
required

The unique ID of the customer source.

agreements
object

Customer's consents.

string

The unique ID of the language by ISO 639-1 code.

partner_records
array of objects

List of partners to associate with the signed-up contact. When provided as a non-empty array, partner assignment is based solely on this list. An empty array is treated the same as omitting this field. See the partner assignment rules in the endpoint description for the full precedence logic. GET /partners

partner_records
Responses
204

No Content

429

Too many requests - more than the resource limit.

503

Temporary state when the service is temporarily unavailable, overloaded or there is a maintenance window.

Updated 17 days ago

Language
Credentials
URL
Response 
Click Try It! to start a request and see the response here! Or choose an example:
application/json
Updated 17 days ago