Subscriptions

Subscriptions Documentation

Subscription [POST]

Subscription [POST]

Request

Endpoint

POST /api/v2/public/designation_accounts/17/subscriptions
Content-Type: application/vnd.api+json
Authorization: Bearer jaofi2cdWGpW7R3Pw5qhCEsX

Body

{
  "data": {
    "type": "subscriptions",
    "attributes": {
      "city": "Blythemouth",
      "country": "Andorra",
      "email": "[e-mail]",
      "first_name": "Marc",
      "last_name": "Franecki",
      "metro_area": "89425",
      "phone_number": "[phone]",
      "postal_code": "30771",
      "region": "Michigan",
      "send_newsletter": "Both",
      "state": "MS",
      "street": "31433 Schimmel Cove"
    }
  }
}

Parameters

Attributes

city

Type string

Description City of contact

Required No

country

Type string

Description Country of contact

Required No

created_at

Type date

Description The timestamp of when this resource was created

Required No

email

Type string

Description eamil address of contact

Required No

first_name

Type string

Description First name of contact

Required No

last_name

Type string

Description Last name of contact

Required No

metro_area

Type string

Description Metro Area of contact

Required No

notes

Type text

Description Open ended field for contact to put comments in

Required No

phone_number

Type integer

Description Phone number of contact

Required No

postal_code

Type string

Description postal code of contact

Required No

region

Type string

Description Region of contact

Required No

send_newsletter

Type string

Description Newsletter preference of contact

Required No

state

Type string

Description state of of contact

Required No

street

Type string

Description street address of contact

Required No

updated_at

Type date

Description The timestamp of when this resource was last updated

Required No

updated_in_db_at

Type date

Description This is to be used as a reference for the last time the resource was updated in the remote database - specifically for when data is updated while the client is offline.

Required No

Response

Headers

Content-Type: application/vnd.api+json; charset=utf-8
201 Created

Body

{
  "data": {
    "id": "f897c166-edfe-4c0c-97b1-0779a651c746",
    "type": "subscriptions",
    "attributes": {
      "city": "Blythemouth",
      "country": "Andorra",
      "created_at": "2021-11-23T14:38:12Z",
      "email": "[e-mail]",
      "first_name": "Marc",
      "last_name": "Franecki",
      "metro_area": "89425",
      "notes": null,
      "phone_number": "[phone]",
      "postal_code": "30771",
      "region": "Michigan",
      "send_newsletter": "Both",
      "state": "MS",
      "street": "31433 Schimmel Cove",
      "updated_at": "2021-11-23T14:38:12Z",
      "updated_in_db_at": "2021-11-23T14:38:12Z"
    }
  }
}

Fields

Attributes

city

Type string

Description City of contact

country

Type string

Description Country of contact

created_at

Type date

Description The timestamp of when this resource was created

email

Type string

Description eamil address of contact

first_name

Type string

Description First name of contact

last_name

Type string

Description Last name of contact

metro_area

Type string

Description Metro Area of contact

notes

Type text

Description Open ended field for contact to put comments in

phone_number

Type integer

Description Phone number of contact

postal_code

Type string

Description postal code of contact

region

Type string

Description Region of contact

send_newsletter

Type string

Description Newsletter preference of contact

state

Type string

Description state of of contact

street

Type string

Description street address of contact

updated_at

Type date

Description The timestamp of when this resource was last updated

updated_in_db_at

Type date

Description This is to be used as a reference for the last time the resource was updated in the remote database - specifically for when data is updated while the client is offline.