Key Accounts

Key Accounts Documentation

Key Account [LIST]

Key Account [LIST]

Request

Endpoint

GET /api/v2/user/key_accounts
Content-Type: application/vnd.api+json

Body

Response

Headers

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

Body

{
  "data": [
    {
      "id": "0719e77e-1e0d-4e82-84c6-5215c07d57c6",
      "type": "key_accounts",
      "attributes": {
        "created_at": "2022-01-12T17:17:55Z",
        "email": "[email protected]",
        "first_name": "Terence",
        "last_download": null,
        "last_name": "Lowe",
        "primary": false,
        "remote_id": "1",
        "updated_at": "2022-01-12T17:17:55Z",
        "updated_in_db_at": "2022-01-12T17:17:55Z"
      }
    }
  ],
  "meta": {
    "pagination": {
      "page": 1,
      "per_page": 25,
      "total_count": 1,
      "total_pages": 1
    },
    "sort": null,
    "filter": {
    }
  }
}

Fields

data

Type [Key Account]

Description An array of Key Accounts

Key Account [POST]

Key Account [POST]

Request

Endpoint

POST /api/v2/user/key_accounts
Content-Type: application/vnd.api+json

Body

{
  "data": {
    "type": "key_accounts",
    "attributes": {
      "email": "[email protected]",
      "first_name": "Stuart",
      "last_name": "Douglas",
      "remote_id": 3,
      "updated_in_db_at": "2022-01-12 17:17:56 UTC"
    }
  }
}

Parameters

Attributes

created_at

Type date

Description The timestamp of when this resource was created

Required No

email

Type string

Description Email

Required No

first_name

Type string

Description First Name

Required No

last_download

Type string

Description Last Download

Required No

last_name

Type string

Description Last Name

Required No

primary

Type boolean

Description Primary

Required No

remote_id

Type number

Description Key Account SSO GUID

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": "fad7e564-ef0c-4a0c-9123-0c5da2799fc0",
    "type": "key_accounts",
    "attributes": {
      "created_at": "2022-01-12T17:17:56Z",
      "email": "[email protected]",
      "first_name": "Stuart",
      "last_download": null,
      "last_name": "Douglas",
      "primary": false,
      "remote_id": "3",
      "updated_at": "2022-01-12T17:17:56Z",
      "updated_in_db_at": "2022-01-12T17:17:56Z"
    }
  }
}

Fields

Attributes

created_at

Type date

Description The timestamp of when this resource was created

email

Type string

Description Email

first_name

Type string

Description First Name

last_download

Type string

Description Last Download

last_name

Type string

Description Last Name

primary

Type boolean

Description Primary

remote_id

Type number

Description Key Account SSO GUID

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.

Key Account [GET]

Key Account [GET]

Request

Endpoint

GET /api/v2/user/key_accounts/9fa46da8-d066-482b-8ca2-5f76c3725144
Content-Type: application/vnd.api+json

Body

Response

Headers

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

Body

{
  "data": {
    "id": "9fa46da8-d066-482b-8ca2-5f76c3725144",
    "type": "key_accounts",
    "attributes": {
      "created_at": "2022-01-12T17:17:56Z",
      "email": "[email protected]",
      "first_name": "Melany",
      "last_download": null,
      "last_name": "Wyman",
      "primary": false,
      "remote_id": "4",
      "updated_at": "2022-01-12T17:17:56Z",
      "updated_in_db_at": "2022-01-12T17:17:56Z"
    }
  }
}

Fields

Attributes

created_at

Type date

Description The timestamp of when this resource was created

email

Type string

Description Email

first_name

Type string

Description First Name

last_download

Type string

Description Last Download

last_name

Type string

Description Last Name

primary

Type boolean

Description Primary

remote_id

Type number

Description Key Account SSO GUID

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.

Key Account [PUT]

Key Account [PUT]

Request

Endpoint

PUT /api/v2/user/key_accounts/033574e8-435c-4ce4-8d70-a95e8fa8c037
Content-Type: application/vnd.api+json

Body

{
  "data": {
    "type": "key_accounts",
    "attributes": {
      "email": "[email protected]",
      "first_name": "Crystal",
      "last_name": "Steuber",
      "remote_id": 7,
      "updated_in_db_at": "2022-01-12 17:17:56 UTC"
    }
  }
}

Parameters

Attributes

created_at

Type date

Description The timestamp of when this resource was created

Required No

email

Type string

Description Email

Required No

first_name

Type string

Description First Name

Required No

last_download

Type string

Description Last Download

Required No

last_name

Type string

Description Last Name

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 Primary

Required No

remote_id

Type number

Description Key Account SSO GUID

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": "033574e8-435c-4ce4-8d70-a95e8fa8c037",
    "type": "key_accounts",
    "attributes": {
      "created_at": "2022-01-12T17:17:56Z",
      "email": "[email protected]",
      "first_name": "Crystal",
      "last_download": null,
      "last_name": "Steuber",
      "primary": false,
      "remote_id": "7",
      "updated_at": "2022-01-12T17:17:56Z",
      "updated_in_db_at": "2022-01-12T17:17:56Z"
    }
  }
}

Fields

Attributes

created_at

Type date

Description The timestamp of when this resource was created

email

Type string

Description Email

first_name

Type string

Description First Name

last_download

Type string

Description Last Download

last_name

Type string

Description Last Name

primary

Type boolean

Description Primary

remote_id

Type number

Description Key Account SSO GUID

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.