Linkedin Accounts

Linkedin Accounts Documentation

Linkedin Account [LIST]

Linkedin Account [LIST]

Request

Endpoint

GET /api/v2/contacts/bf074950-d868-4986-ac9c-34154dd11402/people/bba1988f-a62a-4a0f-9146-a4932ef165c9/linkedin_accounts
Content-Type: application/vnd.api+json

Body

Response

Headers

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

Body

{
  "data": [
    {
      "id": "69140460-56af-496b-9767-d0a3854fae86",
      "type": "linkedin_accounts",
      "attributes": {
        "created_at": "2021-11-23T14:37:58Z",
        "public_url": "http://example.com/username1",
        "updated_at": "2021-11-23T14:37:58Z",
        "updated_in_db_at": "2021-11-23T14:37:58Z"
      }
    }
  ],
  "meta": {
    "pagination": {
      "page": 1,
      "per_page": 25,
      "total_count": 1,
      "total_pages": 1
    },
    "sort": null,
    "filter": {
    }
  }
}

Fields

data

Type [LinkedIn Account]

Description An array of LinkedIn Accounts

Linkedin Account [POST]

Linkedin Account [POST]

Request

Endpoint

POST /api/v2/contacts/6129e3c0-2745-4677-9fbc-757077c4ab31/people/54462a6e-7594-48d2-b4bb-fd9946a8d3fc/linkedin_accounts
Content-Type: application/vnd.api+json

Body

{
  "data": {
    "type": "linkedin_accounts",
    "attributes": {
      "authenticated": true,
      "first_name": "Karoline",
      "last_name": "Schimmel",
      "public_url": "http://example.com/username1",
      "remote_id": "4",
      "updated_in_db_at": "2021-11-23 14:37:57 UTC"
    }
  }
}

Parameters

Attributes

authenticated

Type boolean

Description If the Linkedin Account has been authenticated

Required No

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 Linkedin Account

Required No

last_name

Type string

Description The last name of the Linkedin Account

Required No

public_url

Type string

Description The URL of the Person's LinkedIn Account

Required No

remote_id

Type string

Description The ID of the Linkedin 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

Response

Headers

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

Body

{
  "data": {
    "id": "1b1b9ecd-3c6c-4ca7-afee-a9493f53c116",
    "type": "linkedin_accounts",
    "attributes": {
      "created_at": "2021-11-23T14:37:57Z",
      "public_url": "http://example.com/username1",
      "updated_at": "2021-11-23T14:37:57Z",
      "updated_in_db_at": "2021-11-23T14:37:57Z"
    }
  }
}

Fields

Attributes

created_at

Type date

Description The timestamp of when this resource was created

public_url

Type string

Description The URL of the Person's LinkedIn 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.

Linkedin Account [GET]

Linkedin Account [GET]

Request

Endpoint

GET /api/v2/contacts/ea9c8480-dfd6-46e5-8437-9e60d2c5f5d0/people/42c861fe-8ae8-407f-9717-4b9e74517271/linkedin_accounts/569f006b-7eab-464c-bbde-490322510424
Content-Type: application/vnd.api+json

Body

Response

Headers

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

Body

{
  "data": {
    "id": "569f006b-7eab-464c-bbde-490322510424",
    "type": "linkedin_accounts",
    "attributes": {
      "created_at": "2021-11-23T14:37:58Z",
      "public_url": "http://example.com/username1",
      "updated_at": "2021-11-23T14:37:58Z",
      "updated_in_db_at": "2021-11-23T14:37:58Z"
    }
  }
}

Fields

Attributes

created_at

Type date

Description The timestamp of when this resource was created

public_url

Type string

Description The URL of the Person's LinkedIn 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.

Linkedin Account [PUT]

Linkedin Account [PUT]

Request

Endpoint

PUT /api/v2/contacts/ec997ae0-a053-4c94-a1b7-d7f3dee565a8/people/f0005be0-e5de-47ef-b047-609364e04070/linkedin_accounts/9d6d67af-ffd7-4e53-aa53-220be8b7abba
Content-Type: application/vnd.api+json

Body

{
  "data": {
    "type": "linkedin_accounts",
    "attributes": {
      "authenticated": true,
      "first_name": "Vernice",
      "last_name": "Champlin",
      "public_url": "http://example.com/username1",
      "remote_id": "2",
      "updated_in_db_at": "2021-11-23 14:37:57 UTC"
    }
  }
}

Parameters

Attributes

authenticated

Type boolean

Description If the Linkedin Account has been authenticated

Required No

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 Linkedin Account

Required No

last_name

Type string

Description The last name of the Linkedin 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

public_url

Type string

Description The URL of the Person's LinkedIn Account

Required No

remote_id

Type string

Description The ID of the Linkedin 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

Response

Headers

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

Body

{
  "data": {
    "id": "9d6d67af-ffd7-4e53-aa53-220be8b7abba",
    "type": "linkedin_accounts",
    "attributes": {
      "created_at": "2021-11-23T14:37:57Z",
      "public_url": "http://example.com/username1",
      "updated_at": "2021-11-23T14:37:57Z",
      "updated_in_db_at": "2021-11-23T14:37:57Z"
    }
  }
}

Fields

Attributes

created_at

Type date

Description The timestamp of when this resource was created

public_url

Type string

Description The URL of the Person's LinkedIn 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.

Linkedin Account [DELETE]

Linkedin Account [DELETE]

Request

Endpoint

DELETE /api/v2/contacts/20df0977-c0f6-4a56-b3c3-e8323f996065/people/4377fcf3-c95d-43b2-a867-50c7e65c57bc/linkedin_accounts/fbbb75e7-639d-4a45-b575-7a6e08739ee4
Content-Type: application/vnd.api+json

Body

Response

Headers

204 No Content

Body