Subscribers POST API Endpoint

Joanna
Joanna
  • Updated

Subscribers

POST /api/v3/public/subscribers

API requests must be made with the Content-Type of application/vnd.api+json

Use the following fields:

{  "data":{    "type":"subscriber",    "attributes":{      "name":"STRING",      "email":"STRING",      "project_id":"ID"    }  }}

Example 

{  "data": {    "type": "subscriber",    "attributes": {      "email": "example@civilspace.io",      "name": "Example User",      "project_id": 1    }  }}

   

This will return HTTP 201 or 200 if the subscriber exists:

{  "data": {    "id": "5",    "type": "subscriber",    "attributes": {      "email": "example@civilspace.io",      "all_projects": false,      "name": "Example User"    },    "relationships": {      "projects": {        "data": [          {            "id": "1",            "type": "project"          }        ]      }    }  }}

Was this article helpful?

/

Comments

0 comments

Article is closed for comments.