Twitter Accounts

Twitter Accounts Documentation

Twitter Account [LIST]

Twitter Account [LIST]

Request

Endpoint

GET /api/v2/contacts/58460716-55dc-4bbf-bbf1-a25012a3bc5d/people/f5f042fc-0c92-49d8-9e4b-5a3c9abedfe7/twitter_accounts
Content-Type: application/vnd.api+json

Body

Response

Headers

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

Body

{
  "data": [
    {
      "id": "e79c1816-64f1-4399-8e4a-24c0a76be27e",
      "type": "twitter_accounts",
      "attributes": {
        "created_at": "2022-01-12T17:19:02Z",
        "primary": false,
        "remote_id": 5,
        "screen_name": "scotty",
        "updated_at": "2022-01-12T17:19:02Z",
        "updated_in_db_at": "2022-01-12T17:19:02Z"
      }
    }
  ],
  "meta": {
    "pagination": {
      "page": 1,
      "per_page": 25,
      "total_count": 1,
      "total_pages": 1
    },
    "sort": null,
    "filter": {
    }
  }
}

Fields

data

Type [Twitter Account]

Description An array of Twitter Accounts

Twitter Account [POST]

Twitter Account [POST]

Request

Endpoint

POST /api/v2/contacts/b2afeec2-5ae2-4d66-95a9-1ad7ae8d1cc5/people/30031f45-01c6-4429-b503-1e6d3b428d9d/twitter_accounts
Content-Type: application/vnd.api+json

Body

{
  "data": {
    "type": "twitter_accounts",
    "attributes": {
      "remote_id": 2,
      "screen_name": "charles",
      "updated_in_db_at": "2022-01-12 17:19:02 UTC"
    }
  }
}

Parameters

Attributes

created_at

Type date

Description The timestamp of when this resource was created

Required No

primary

Type boolean

Description Whether or not this Twitter Account is the Person's primary account

Required No

remote_id

Type integer

Description The id for this Twitter Account from Twitter.com (this will likely be null)

Required No

screen_name

Type string

Description The screen name for the Person's Twitter Account

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": "fe914dd6-940c-4c97-994d-60e1c496907c",
    "type": "twitter_accounts",
    "attributes": {
      "created_at": "2022-01-12T17:19:02Z",
      "primary": false,
      "remote_id": 2,
      "screen_name": "charles",
      "updated_at": "2022-01-12T17:19:02Z",
      "updated_in_db_at": "2022-01-12T17:19:02Z"
    }
  }
}

Fields

Attributes

created_at

Type date

Description The timestamp of when this resource was created

primary

Type boolean

Description Whether or not this Twitter Account is the Person's primary account

remote_id

Type integer

Description The id for this Twitter Account from Twitter.com (this will likely be null)

screen_name

Type string

Description The screen name for the Person's Twitter Account

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.

Twitter Account [GET]

Twitter Account [GET]

Request

Endpoint

GET /api/v2/contacts/75da6c6c-339e-4a19-9b68-9d1d1699ea53/people/f63c4d65-ccb0-4838-a5ec-883b83cafe03/twitter_accounts/154d21c0-848d-4ec5-8aa2-0faf8f8d38d2
Content-Type: application/vnd.api+json

Body

Response

Headers

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

Body

{
  "data": {
    "id": "154d21c0-848d-4ec5-8aa2-0faf8f8d38d2",
    "type": "twitter_accounts",
    "attributes": {
      "created_at": "2022-01-12T17:19:03Z",
      "primary": false,
      "remote_id": 7,
      "screen_name": "whitney_weber",
      "updated_at": "2022-01-12T17:19:03Z",
      "updated_in_db_at": "2022-01-12T17:19:03Z"
    }
  }
}

Fields

Attributes

created_at

Type date

Description The timestamp of when this resource was created

primary

Type boolean

Description Whether or not this Twitter Account is the Person's primary account

remote_id

Type integer

Description The id for this Twitter Account from Twitter.com (this will likely be null)

screen_name

Type string

Description The screen name for the Person's Twitter Account

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.

Twitter Account [PUT]

Twitter Account [PUT]

Request

Endpoint

PUT /api/v2/contacts/ffda801f-21ac-4d43-9d80-c40c22997815/people/ed4b1895-1905-4eee-b2ae-2cb0c4fbbd08/twitter_accounts/c2deeead-c369-49e7-a00f-234f2137c1e2
Content-Type: application/vnd.api+json

Body

{
  "data": {
    "type": "twitter_accounts",
    "attributes": {
      "remote_id": 4,
      "screen_name": "dottie",
      "updated_in_db_at": "2022-01-12 17:19:02 UTC"
    }
  }
}

Parameters

Attributes

created_at

Type date

Description The timestamp of when this resource was created

Required No

overwrite

Type boolean

Description Only used for updating a record where you want to ignore the server's ' 'updated_in_db_at value and force overwrite the values for the record. ' 'Must be true to work.

Required No

primary

Type boolean

Description Whether or not this Twitter Account is the Person's primary account

Required No

remote_id

Type integer

Description The id for this Twitter Account from Twitter.com (this will likely be null)

Required No

screen_name

Type string

Description The screen name for the Person's Twitter Account

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
200 OK

Body

{
  "data": {
    "id": "c2deeead-c369-49e7-a00f-234f2137c1e2",
    "type": "twitter_accounts",
    "attributes": {
      "created_at": "2022-01-12T17:19:02Z",
      "primary": false,
      "remote_id": 4,
      "screen_name": "dottie",
      "updated_at": "2022-01-12T17:19:02Z",
      "updated_in_db_at": "2022-01-12T17:19:02Z"
    }
  }
}

Fields

Attributes

created_at

Type date

Description The timestamp of when this resource was created

primary

Type boolean

Description Whether or not this Twitter Account is the Person's primary account

remote_id

Type integer

Description The id for this Twitter Account from Twitter.com (this will likely be null)

screen_name

Type string

Description The screen name for the Person's Twitter Account

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.

Twitter Account [DELETE]

Twitter Account [DELETE]

Request

Endpoint

DELETE /api/v2/contacts/25335164-f510-4cff-ad73-466ae75b7888/people/fb110bc2-cf8e-478a-a63c-deb35b365dee/twitter_accounts/871cd1d8-1fbe-43dc-aa6f-252ec198b943
Content-Type: application/vnd.api+json

Body

Response

Headers

204 No Content

Body