Documentation

Documentation

YourOwn SetupYourOwn SDKYourOwn API
Sphere SetupSphere SDKSphere API
  • Resources

›Collect payload

Introduction

  • Copilot.cx Server API

Reference

  • Collect API
  • Collect payload

    • User events
    • Thing events
    • Custom events
    • Misc. events
    • Preexisting sync events
  • Consent endpoint

Appendix

  • Releases

Misc. events

Unsubscribe event

This will mark this user on Copilot.cx as unsubscribed of getting emails from Copilot. Dispatch this event when the user unsubscribes from a mailing list you have.

Please refer the user_id and thing_id best practices here.

  • Type: unsubscribe

  • Payload fields:

FieldTypeDescriptionMandatory
emailStringA valid email address to be used for an engagement campaignY
  • Example
    {
      "events": [
        {
          "type": "unsubscribe",
          "event_id": "d8a4ee55-da8f-4f0a-99b7-3f48629462fd",
          "timestamp": 1559570638730,
          "payload": {
            "email": "juanita.pagac43@mailinator.com"
          }
        }
      ]
    }
    
← Custom eventsPreexisting sync events →
  • Unsubscribe event
Copilot
Mail: hello@copilot.cx
Call: (212).398.0001
© Copilot.cx 2025