Linkedin Accounts

Linkedin Accounts Documentation

Linkedin Account [LIST]

Linkedin Account [LIST]

Request

Endpoint

GET /api/v2/contacts/73136dfe-f692-4348-8321-d64d096906c5/people/f4b5357d-ce5b-4544-82e6-ba04d6a0045f/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": "4af005de-6386-4067-93bc-b75fa2b171ec",
      "type": "linkedin_accounts",
      "attributes": {
        "created_at": "2022-01-12T17:18:56Z",
        "public_url": "http://example.com/username1",
        "updated_at": "2022-01-12T17:18:56Z",
        "updated_in_db_at": "2022-01-12T17:18:56Z"
      }
    }
  ],
  "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/4aa73fa2-9086-43ab-8761-29c2b198a9a2/people/ab4cd479-0bcd-4451-8331-d3b33f01dca5/linkedin_accounts
Content-Type: application/vnd.api+json

Body

{
  "data": {
    "type": "linkedin_accounts",
    "attributes": {
      "authenticated": true,
      "first_name": "Rickey",
      "last_name": "Flatley",
      "public_url": "http://example.com/username1",
      "remote_id": "2",
      "updated_in_db_at": "2022-01-12 17:18:56 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": "e7400f11-8a9d-45e4-a8d6-c1acd7b1bfc2",
    "type": "linkedin_accounts",
    "attributes": {
      "created_at": "2022-01-12T17:18:56Z",
      "public_url": "http://example.com/username1",
      "updated_at": "2022-01-12T17:18:56Z",
      "updated_in_db_at": "2022-01-12T17:18:56Z"
    }
  }
}

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/25957d8b-db33-4aee-bef2-594eb51b65fa/people/86ce27dd-0196-446b-9f40-21688ed9fbc2/linkedin_accounts/215a16e3-2c85-40c2-8367-90f445f8047e
Content-Type: application/vnd.api+json

Body

Response

Headers

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

Body

{
  "data": {
    "id": "215a16e3-2c85-40c2-8367-90f445f8047e",
    "type": "linkedin_accounts",
    "attributes": {
      "created_at": "2022-01-12T17:18:57Z",
      "public_url": "http://example.com/username1",
      "updated_at": "2022-01-12T17:18:57Z",
      "updated_in_db_at": "2022-01-12T17:18: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 [PUT]

Linkedin Account [PUT]

Request

Endpoint

PUT /api/v2/contacts/c3cb2e41-cc77-4326-8b79-a3415c3e358e/people/076a854d-4374-4cba-a55c-010bc1f39205/linkedin_accounts/f0a80966-f1dc-4738-914c-4da5c89be336
Content-Type: application/vnd.api+json

Body

{
  "data": {
    "type": "linkedin_accounts",
    "attributes": {
      "authenticated": true,
      "first_name": "Simon",
      "last_name": "Bins",
      "public_url": "http://example.com/username1",
      "remote_id": "8",
      "updated_in_db_at": "2022-01-12 17:18: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": "f0a80966-f1dc-4738-914c-4da5c89be336",
    "type": "linkedin_accounts",
    "attributes": {
      "created_at": "2022-01-12T17:18:57Z",
      "public_url": "http://example.com/username1",
      "updated_at": "2022-01-12T17:18:57Z",
      "updated_in_db_at": "2022-01-12T17:18: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/8416df61-6b22-4525-ac21-9393dfd948b7/people/a73fdcf7-5f7b-4abc-8487-d723e6ba168e/linkedin_accounts/dae1d58e-2f83-4af3-9e88-5d43b1bea418
Content-Type: application/vnd.api+json

Body

Response

Headers

204 No Content

Body