Go to app

Lists

The segments endpoint provides access to lists where you can organize and manage contacts.

Creates a Segment resource.

post

Creates a Segment resource.

Authorizations
Body
@contextone ofRead-onlyOptional
stringOptional
or
@idstringRead-onlyOptional
@typestringRead-onlyOptional
idstring | nullOptional
titlestring | nullRequired
iconstring | nullRequired
sequenceinteger | nullOptional
Responses
201
Segment resource created
post
POST /segments HTTP/1.1
Host: api.rogerroger.io
X-API-KEY: YOUR_API_KEY
Content-Type: application/ld+json
Accept: */*
Content-Length: 52

{
  "id": null,
  "title": null,
  "icon": null,
  "sequence": null
}
{
  "@context": "text",
  "@id": "text",
  "@type": "text",
  "id": null,
  "title": null,
  "icon": null,
  "sequence": null
}

Retrieves a Segment resource.

get

Retrieves a Segment resource.

Authorizations
Path parameters
idstringRequired

Segment identifier

Responses
200
Segment resource
get
GET /segments/{id} HTTP/1.1
Host: api.rogerroger.io
X-API-KEY: YOUR_API_KEY
Accept: */*

{
  "@context": "text",
  "@id": "text",
  "@type": "text",
  "id": null,
  "title": null,
  "icon": null,
  "sequence": null
}

Updates the Segment resource.

patch

Updates the Segment resource.

Authorizations
Path parameters
idstringRequired

Segment identifier

Body
idstring | nullOptional
titlestring | nullRequired
iconstring | nullRequired
sequenceinteger | nullOptional
Responses
200
Segment resource updated
patch
PATCH /segments/{id} HTTP/1.1
Host: api.rogerroger.io
X-API-KEY: YOUR_API_KEY
Content-Type: application/merge-patch+json
Accept: */*
Content-Length: 52

{
  "id": null,
  "title": null,
  "icon": null,
  "sequence": null
}
{
  "@context": "text",
  "@id": "text",
  "@type": "text",
  "id": null,
  "title": null,
  "icon": null,
  "sequence": null
}

Replaces the Segment resource.

put

Replaces the Segment resource.

Authorizations
Path parameters
idstringRequired

Segment identifier

Body
@contextone ofRead-onlyOptional
stringOptional
or
@idstringRead-onlyOptional
@typestringRead-onlyOptional
idstring | nullOptional
titlestring | nullRequired
iconstring | nullRequired
sequenceinteger | nullOptional
Responses
200
Segment resource updated
put
PUT /segments/{id} HTTP/1.1
Host: api.rogerroger.io
X-API-KEY: YOUR_API_KEY
Content-Type: application/ld+json
Accept: */*
Content-Length: 52

{
  "id": null,
  "title": null,
  "icon": null,
  "sequence": null
}
{
  "@context": "text",
  "@id": "text",
  "@type": "text",
  "id": null,
  "title": null,
  "icon": null,
  "sequence": null
}

Retrieves the collection of Segment resources.

get

Retrieves the collection of Segment resources.

Authorizations
Query parameters
pageintegerOptional

The collection page number

Default: 1
itemsPerPageinteger · max: 30Optional

The number of items per page

Default: 15
Responses
200
Segment collection
get
GET /segments HTTP/1.1
Host: api.rogerroger.io
X-API-KEY: YOUR_API_KEY
Accept: */*

{
  "member": [
    {
      "@context": "text",
      "@id": "text",
      "@type": "text",
      "id": null,
      "title": null,
      "icon": null,
      "sequence": null
    }
  ],
  "totalItems": 1,
  "view": {
    "@id": "string",
    "type": "string",
    "first": "string",
    "last": "string",
    "previous": "string",
    "next": "string"
  },
  "search": {
    "@type": "text",
    "template": "text",
    "variableRepresentation": "text",
    "mapping": [
      {
        "@type": "text",
        "variable": "text",
        "property": null,
        "required": true
      }
    ]
  }
}
PreviousOrganizationsNextWorkspaces

Last updated