Facebook Accounts

Facebook Accounts Documentation

Facebook Account [LIST]

Facebook Account [LIST]

Request

Endpoint

GET /api/v2/contacts/d83e7359-977c-4c81-a62e-0abd9832a7f9/people/ecea97fc-2da2-4b60-a480-d0bb99e5956c/facebook_accounts
Content-Type: application/vnd.api+json

Body

Response

Headers

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

Body

{
  "data": [
    {
      "id": "0b23a62e-97bb-49dd-b7f9-16696e201143",
      "type": "facebook_accounts",
      "attributes": {
        "created_at": "2022-01-12T17:18:25Z",
        "first_name": "Wilson",
        "last_name": "Legros",
        "remote_id": 7,
        "updated_at": "2022-01-12T17:18:25Z",
        "updated_in_db_at": "2022-01-12T17:18:25Z",
        "username": "wilson.legros"
      }
    }
  ],
  "meta": {
    "pagination": {
      "page": 1,
      "per_page": 25,
      "total_count": 1,
      "total_pages": 1
    },
    "sort": null,
    "filter": {
    }
  }
}

Fields

data

Type [Facebook Account]

Description An array of Facebook Accounts

Facebook Account [POST]

Facebook Account [POST]

Request

Endpoint

POST /api/v2/contacts/afe8ceee-fe97-4e46-8fc4-827817f72803/people/c9383684-217e-4d42-b33d-e81647751f2b/facebook_accounts
Content-Type: application/vnd.api+json

Body

{
  "data": {
    "type": "facebook_accounts",
    "attributes": {
      "first_name": "Evelia",
      "last_name": "Hammes",
      "remote_id": 9,
      "updated_in_db_at": "2022-01-12 17:18:25 UTC",
      "username": "evelia.hammes"
    }
  }
}

Parameters

Attributes

created_at

Type date

Description The timestamp of when this resource was created

Required No

first_name

Type string

Description The first name of the Facebook Account

Required No

last_name

Type string

Description The last name of the Facebook Account

Required No

remote_id

Type string

Description The ID of the Facebook Account in the remote system

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

username

Type string

Description The username of the Facebook Account in the remote system

Required No

Response

Headers

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

Body

{
  "data": {
    "id": "fdf9cb80-58a3-4717-bd1c-c9fcb9d06f25",
    "type": "facebook_accounts",
    "attributes": {
      "created_at": "2022-01-12T17:18:25Z",
      "first_name": "Evelia",
      "last_name": "Hammes",
      "remote_id": 9,
      "updated_at": "2022-01-12T17:18:25Z",
      "updated_in_db_at": "2022-01-12T17:18:25Z",
      "username": "evelia.hammes"
    }
  }
}

Fields

Attributes

created_at

Type date

Description The timestamp of when this resource was created

first_name

Type string

Description The first name of the Facebook Account

last_name

Type string

Description The last name of the Facebook Account

remote_id

Type string

Description The ID of the Facebook Account in the remote system

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.

username

Type string

Description The username of the Facebook Account in the remote system

Facebook Account [GET]

Facebook Account [GET]

Request

Endpoint

GET /api/v2/contacts/700d0ae7-8527-4a39-a4bf-05badb04300a/people/0673e6b3-8596-4881-a0c9-4fd696a15ecb/facebook_accounts/a0a2b4d5-4f7d-4299-9841-a6b3d800e6c7
Content-Type: application/vnd.api+json

Body

Response

Headers

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

Body

{
  "data": {
    "id": "a0a2b4d5-4f7d-4299-9841-a6b3d800e6c7",
    "type": "facebook_accounts",
    "attributes": {
      "created_at": "2022-01-12T17:18:25Z",
      "first_name": "Cornell",
      "last_name": "Thompson",
      "remote_id": 5,
      "updated_at": "2022-01-12T17:18:25Z",
      "updated_in_db_at": "2022-01-12T17:18:25Z",
      "username": "cornell.thompson"
    }
  }
}

Fields

Attributes

created_at

Type date

Description The timestamp of when this resource was created

first_name

Type string

Description The first name of the Facebook Account

last_name

Type string

Description The last name of the Facebook Account

remote_id

Type string

Description The ID of the Facebook Account in the remote system

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.

username

Type string

Description The username of the Facebook Account in the remote system

Facebook Account [PUT]

Facebook Account [PUT]

Request

Endpoint

PUT /api/v2/contacts/95f5b094-2cec-4ce6-a45f-c136a047433b/people/1ebe7134-026f-49a3-978a-854de79d9d88/facebook_accounts/c1902689-8d78-46b6-8f9f-27eba4c27772
Content-Type: application/vnd.api+json

Body

{
  "data": {
    "type": "facebook_accounts",
    "attributes": {
      "first_name": "Oswaldo",
      "last_name": "Schoen",
      "remote_id": 4,
      "updated_in_db_at": "2022-01-12 17:18:25 UTC",
      "username": "oswaldo_schoen"
    }
  }
}

Parameters

Attributes

created_at

Type date

Description The timestamp of when this resource was created

Required No

first_name

Type string

Description The first name of the Facebook Account

Required No

last_name

Type string

Description The last name of the Facebook Account

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

remote_id

Type string

Description The ID of the Facebook Account in the remote system

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

username

Type string

Description The username of the Facebook Account in the remote system

Required No

Response

Headers

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

Body

{
  "data": {
    "id": "c1902689-8d78-46b6-8f9f-27eba4c27772",
    "type": "facebook_accounts",
    "attributes": {
      "created_at": "2022-01-12T17:18:25Z",
      "first_name": "Oswaldo",
      "last_name": "Schoen",
      "remote_id": 4,
      "updated_at": "2022-01-12T17:18:25Z",
      "updated_in_db_at": "2022-01-12T17:18:25Z",
      "username": "oswaldo_schoen"
    }
  }
}

Fields

Attributes

created_at

Type date

Description The timestamp of when this resource was created

first_name

Type string

Description The first name of the Facebook Account

last_name

Type string

Description The last name of the Facebook Account

remote_id

Type string

Description The ID of the Facebook Account in the remote system

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.

username

Type string

Description The username of the Facebook Account in the remote system

Facebook Account [DELETE]

Facebook Account [DELETE]

Request

Endpoint

DELETE /api/v2/contacts/8a6d19ee-61cd-4e12-b697-16d1973110f2/people/dda7e654-00fe-4805-b301-58ad41cc5bf1/facebook_accounts/b49d6213-ddb9-43ca-af38-3065f6b3d321
Content-Type: application/vnd.api+json

Body

Response

Headers

204 No Content

Body