v1

latestOpenAPI 3.0.2EULA2026-07-143221521.2 MB

Customers actions

Sign up for newsletters

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.

post/customers/actions/newsletters-sign-up

Request body

contactstring required

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

customer_source_idstring required

The unique ID of the customer source.

language_idstring

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

Example request

{
  "contact": "happy_customer@crmcarecloud.com",
  "customer_source_id": "86e05affc7a7abefcd513ab400",
  "agreements": {
    "agreement_gtc": 1,
    "agreement_profiling": 1,
    "agreement_marketing_communication": 1,
    "custom_agreements": [
      {
        "agreement_id": "8fd73167342d06899c4c015320",
        "agreement_value": 2
      }
    ]
  },
  "language_id": "en",
  "partner_records": [
    {
      "partner_id": "86e05affc7a7abefcd513ab400"
    }
  ]
}

Response

No Content