Omnigage API

An API for managing an Omnigage account.

This blueprint uses the following specifications:

API Blueprint - format 1A revision 9
JSON API - v1.0 stable

Collaborator Resources

Most resource instances by default are only accessible by the creator. To grant additional access to other memberships within an account, collaborators can be created for supported resources.

Permission conventions are as follows:

read can retrieve resources the collaborator has access to. This includes relationships. The membership can only read their own collaborator instance.
write includes read privileges. Can also edit the resource and relationships.
admin can add, edit and archive collaborators for the given subject.

Memberships that are not an account admin can view their own collaborators instances by retrieving /{resource}/{id}/collaborators. This allows the membership to view their own credentials without knowing their collaborator ID. A membership can read their own collaborator instance. If a membership is associated to more than one collaborator (e.g., due to teams), the highest level of permission is granted.

E.164 Phone Numbers

Where specified, E.164 is the format used for telephone numbers. The format is as follows: +<CountryCode><City/AreaCode><LocalNumber>;ext=<ext>. The following extension formats are supported:

;ext= - +15197566220;ext=124
, - +15197566220,124
x - +15197566220x124
# - +15197566220#124

Revision Resources

A revised instance carries a primary and a revision relationship. Resources that are revised have special id handling. In the resource itself, the id returned is always the original primary id. It is consistent no matter what revision the resource is on. This allows for binding the resource and always using the latest revision. In the nested /revisions resource, the id returned is the revision id. To differentiate between a primary and revision id, see corresponding relationships on the instance. Note A revision id can be used to load an instance from the shallow resource (e.g. /email-templates/{revision_id}). If the primary id is used, the latest revision is returned (e.g. /email-templates/{primary_id}).

Bulk Requests

A variety of resources support bulk requests where noted. Set the Content-Type and Accept to application/vnd.api+json; ext=bulk and include an array of resource objects. Each resource object must contain at least an id and type. Below are the following rules:

Bulk requests must not exceed 500 resource objects.
A request must completely succeed or fail. Any bulk request must only succeed if all operations are performed successfully. If any individual operation fails, the state of the server will not be changed.

Deleting Multiple Resources

DELETE /contacts
Content-Type: application/vnd.api+json; ext=bulk
Accept: application/vnd.api+json; ext=bulk

{
  "data": [
    { "type": "contacts", "id": "kPvvoxbt8gguembmcX9A4J" },
    { "type": "contacts", "id": "66BAsuo257r4acyBepDZXj" }
  ]
}

Resources Supporting Meta

Certain resources support key/value pairs. The following restrictions apply:

Only string values are accepted
Max number of key/value pairs is limited to 20
Each key is unique
Both keys and values are case sensitive
Maximum key length is 128 Unicode UTF-8 characters
Maximum value length is 256 Unicode UTF-8 characters

Error Codes

10101 - Multi-factor authentication is required.
13000 - Invalid account-key specified.
13001 - You may not edit an archived resource.
13022 - Collaborator resource already exists for this membership.
13101 - You may not edit your own membership.
13201 - You may not edit a historical engagement.
13202 - This engagement may not be edited.
13401 - You may not edit someone else’s note.
13501 - One or more of the specified resources are invalid.
14001 - Collaborator resource already exists for this team.
14002 - Collaborator resource already exists for this user.

Authentication ¶

Resources for interfacing with OAuth2 Bearer Tokens.

Token ¶

Once created, use the token as a header: Authorization: Bearer Go0jY2hFDSGTTQARY0lQoqP9

Create Token
POST`/oauth2/tokens`

Example URI

POST https://api.omnigage.io/api/v1/oauth2/tokens

Request Token

HideShow

Headers

Content-Type: application/x-www-form-urlencoded

Body

grant_type=password&username=alexander.bell@bell-labs.com&password=hlywrmJfD7vM8LpVg

Response 200

HideShow

Body

{
  "access-token": "Go0jY2hFDSGTTQARY0lQoqP9",
  "token_type": "Bearer",
  "expires-in": 3600,
  "refresh_token": "AMDkqyVkwaL9UV4kc1fDx9"
}

Request Refresh

HideShow

Headers

Authorization: Bearer Go0jY2hFDSGTTQARY0lQoqP9
Content-Type: application/x-www-form-urlencoded

Body

grant_type=refresh_token&refresh_token=AMDkqyVkwaL9UV4kc1fDx9

Response 200

HideShow

Body

{
  "access-token": "Tno7IsEGi5jmeqw64FtYk",
  "token_type": "Bearer",
  "expires-in": 3600,
  "refresh_token": "CF6NIkGkJ8grcHyL4qfBAe2"
}

Revoke ¶

Revoke a Bearer or refresh_token.

Revoke Token
POST`/oauth2/revoke`

Example URI

POST https://api.omnigage.io/api/v1/oauth2/revoke

Request

HideShow

Headers

Content-Type: application/x-www-form-urlencoded

Body

token=Tno7IsEGi5jmeqw64FtYk

Response 200

User Resources ¶

Member ¶

This resource is a helper for gaining context of the currently authenticated user of the account.

It is encouraged to side-load from this resource both user and/or account.

Retrieve Member
GET`/member`

Retrieve an existing membership instance within the context of this account.

Example URI

GET https://api.omnigage.io/api/v1/member

Response 200

HideShow

Body

{
  "data": {
    "id": "wpsWLdLt9nscn2jbTD3uxe",
    "type": "memberships",
    "attributes": {
      "first-name": "Alexander",
      "last-name": "Bell",
      "email-address": "alexander.bell@bell-labs.com",
      "default-masked-phone-number": null,
      "is-accepted": true,
      "is-account-admin": false,
      "is-compliance-admin": false,
      "is-compliance-notification-enabled": false,
      "is-compliance-notification-text-enabled": false,
      "is-compliance-notification-email-enabled": false,
      "is-archived": false,
      "member-status-updated-at": "2020-01-01T00:00:00+00:00",
      "created-at": "2020-01-01T00:00:00+00:00",
      "updated-at": "2020-01-01T00:00:00+00:00",
      "deleted-at": null
    },
    "relationships": {
      "member-status": {
        "data": {
          "type": "member-statuses",
          "id": "Zd4dJXrbk4cLDiLcuEL3Kd"
        }
      },
      "user": {
        "data": {
          "type": "users",
          "id": "c8sh5y9hdSMS6zVnrvf53T"
        }
      },
      "picture": {
        "data": {
          "type": "pictures",
          "id": "AuEo9RyrUsV4MXEiDZpLM"
        }
      },
      "caller-id": {
        "data": {
          "type": "caller-ids",
          "id": "jR7uSB8JYWzfXfkp8CyVeV"
        }
      },
      "email-id": {
        "data": {
          "type": "email-ids",
          "id": "J6DHiRVAhZ5Ji5DARZam4Z"
        }
      },
      "phone-number": {
        "data": {
          "type": "phone-numbers",
          "id": "jbPAifRrHj2RZZCd79k9HA"
        }
      },
      "created-by": {
        "data": {
          "type": "memberships",
          "id": "C7xWERND6yBTpJJVHACzVf"
        }
      },
      "updated-by": {
        "data": {
          "type": "memberships",
          "id": "C7xWERND6yBTpJJVHACzVf"
        }
      },
      "deleted-by": {
        "data": null
      }
    }
  }
}

Update Member
PATCH`/member`

Update current authenticated member instance.

Example URI

PATCH https://api.omnigage.io/api/v1/member

Request

HideShow

Body

{
  "data": {
    "id": "wpsWLdLt9nscn2jbTD3uxe",
    "type": "memberships",
    "attributes": {
      "first-name": "Alexander",
      "last-name": "Bell",
      "email-address": "alexander.bell@bell-labs.com",
      "default-masked-phone-number": null,
      "is-accepted": true,
      "is-account-admin": false,
      "is-compliance-admin": false,
      "is-compliance-notification-enabled": false,
      "is-compliance-notification-text-enabled": false,
      "is-compliance-notification-email-enabled": false,
      "is-archived": false,
      "member-status-updated-at": "2020-01-01T00:00:00+00:00",
      "created-at": "2020-01-01T00:00:00+00:00",
      "updated-at": "2020-01-01T00:00:00+00:00",
      "deleted-at": null
    },
    "relationships": {
      "member-status": {
        "data": {
          "type": "member-statuses",
          "id": "Zd4dJXrbk4cLDiLcuEL3Kd"
        }
      },
      "user": {
        "data": {
          "type": "users",
          "id": "c8sh5y9hdSMS6zVnrvf53T"
        }
      },
      "picture": {
        "data": {
          "type": "pictures",
          "id": "AuEo9RyrUsV4MXEiDZpLM"
        }
      },
      "caller-id": {
        "data": {
          "type": "caller-ids",
          "id": "jR7uSB8JYWzfXfkp8CyVeV"
        }
      },
      "email-id": {
        "data": {
          "type": "email-ids",
          "id": "J6DHiRVAhZ5Ji5DARZam4Z"
        }
      },
      "phone-number": {
        "data": {
          "type": "phone-numbers",
          "id": "jbPAifRrHj2RZZCd79k9HA"
        }
      },
      "created-by": {
        "data": {
          "type": "memberships",
          "id": "C7xWERND6yBTpJJVHACzVf"
        }
      },
      "updated-by": {
        "data": {
          "type": "memberships",
          "id": "C7xWERND6yBTpJJVHACzVf"
        }
      },
      "deleted-by": {
        "data": null
      }
    }
  }
}

Response 202

HideShow

Body

{
  "data": {
    "id": "wpsWLdLt9nscn2jbTD3uxe",
    "type": "memberships",
    "attributes": {
      "first-name": "Alexander",
      "last-name": "Bell",
      "email-address": "alexander.bell@bell-labs.com",
      "default-masked-phone-number": null,
      "is-accepted": true,
      "is-account-admin": false,
      "is-compliance-admin": false,
      "is-compliance-notification-enabled": false,
      "is-compliance-notification-text-enabled": false,
      "is-compliance-notification-email-enabled": false,
      "is-archived": false,
      "member-status-updated-at": "2020-01-01T00:00:00+00:00",
      "created-at": "2020-01-01T00:00:00+00:00",
      "updated-at": "2020-01-01T00:00:00+00:00",
      "deleted-at": null
    },
    "relationships": {
      "member-status": {
        "data": {
          "type": "member-statuses",
          "id": "Zd4dJXrbk4cLDiLcuEL3Kd"
        }
      },
      "user": {
        "data": {
          "type": "users",
          "id": "c8sh5y9hdSMS6zVnrvf53T"
        }
      },
      "picture": {
        "data": {
          "type": "pictures",
          "id": "AuEo9RyrUsV4MXEiDZpLM"
        }
      },
      "caller-id": {
        "data": {
          "type": "caller-ids",
          "id": "jR7uSB8JYWzfXfkp8CyVeV"
        }
      },
      "email-id": {
        "data": {
          "type": "email-ids",
          "id": "J6DHiRVAhZ5Ji5DARZam4Z"
        }
      },
      "phone-number": {
        "data": {
          "type": "phone-numbers",
          "id": "jbPAifRrHj2RZZCd79k9HA"
        }
      },
      "created-by": {
        "data": {
          "type": "memberships",
          "id": "C7xWERND6yBTpJJVHACzVf"
        }
      },
      "updated-by": {
        "data": {
          "type": "memberships",
          "id": "C7xWERND6yBTpJJVHACzVf"
        }
      },
      "deleted-by": {
        "data": null
      }
    }
  }
}

User ¶

This resource manages retrieving a specified user instance.

Note: Only individual users belonging to this account can be retrieved. Instances are governed by the user’s defined privacy policy.

Retrieve User
GET`/users/`

Retrieve an existing user instance.

Example URI

GET https://api.omnigage.io/api/v1/users/

Response 200

HideShow

Body

{
  "data": {
    "type": "users",
    "id": "cu8Eo9RyrUsV4MXEiDZpLM",
    "attributes": {
      "username": "alexander.bell",
      "title": "Mr.",
      "first-name": "Alexander",
      "last-name": "Bell",
      "company": "Bell Telephone Company",
      "birthday": "1847-03-03",
      "gender": "male",
      "updated-at": "2020-01-01T00:00:00+00:00",
      "created-at": "2020-01-01T00:00:00+00:00"
    },
    "relationships": {
      "timezone": {
        "data": {
          "type": "timezones",
          "id": "cu8Eo9RyrUsV4MXEiDZpLM"
        }
      },
      "addresses": {
        "links": {
          "related": "/users/cu8Eo9RyrUsV4MXEiDZpLM/addresses"
        },
        "data": [
          {
            "type": "users-addresses",
            "id": "cu8Eo9RyrUsV4MXEiDZpLM"
          }
        ]
      },
      "emails": {
        "links": {
          "related": "/users/cu8Eo9RyrUsV4MXEiDZpLM/emails"
        },
        "data": [
          {
            "type": "users-emails",
            "id": "c8sh5y9hdSMS6zVnrvf53T"
          }
        ]
      },
      "phones": {
        "links": {
          "related": "/users/cu8Eo9RyrUsV4MXEiDZpLM/phones"
        },
        "data": [
          {
            "type": "users-phones",
            "id": "wpsWLdLt9nscn2jbTD3uxe"
          }
        ]
      },
      "primary-address": {
        "data": {
          "type": "users-addresses",
          "id": "cu8Eo9RyrUsV4MXEiDZpLM"
        }
      },
      "primary-email": {
        "data": {
          "type": "users-emails",
          "id": "c8sh5y9hdSMS6zVnrvf53T"
        }
      },
      "primary-phone": {
        "data": {
          "type": "users-phones",
          "id": "wpsWLdLt9nscn2jbTD3uxe"
        }
      },
      "picture": {
        "data": {
          "type": "pictures",
          "id": "cu8Eo9RyrUsV4MXEiDZpLM"
        }
      },
      "contact-preference": {
        "data": {
          "type": "contact-preferences",
          "id": "mjfWDqxLtbXG9poUEYYTAf"
        }
      }
    }
  }
}

User Address Collection ¶

This resource manages the retrieval of user address collections.

Retrieve User Addresses
GET`/users/addresses{?include,filter,sort,page}`

Retrieve a collection of user addresses.

Example URI

GET https://api.omnigage.io/api/v1/users/addresses?include=&filter=1&sort=created-at&page=10

URI Parameters

HideShow

include: string (optional)
Include one ore more related relationships using comma separated name.
sort: string (optional) Example: created-at
Sort on one or more fields using comma separated values.
filter: string (optional) Example: 1
Filter on one or more fields using comma separated values filter[field]=1,2.
page: string (optional) Example: 10
Use page[limit]=10 to reduce the number of instances returned. Use ?page[offset]=10 to skip this many instances.

Response 200

HideShow

Body

{
  "links": {
    "self": "/users/cu8Eo9RyrUsV4MXEiDZpLM/addresses",
    "next": "/users/cu8Eo9RyrUsV4MXEiDZpLM/addresses?page[offset]=10",
    "last": "/users/cu8Eo9RyrUsV4MXEiDZpLM/addresses?page[offset]=100"
  },
  "meta": {
    "total": 110
  },
  "data": [
    {
      "id": "RaF56o2r58hTKT7AYS9doj",
      "type": "users-addresses",
      "attributes": {
        "label": "Address 1",
        "address1": "94 Tutela Heights Road",
        "address2": null,
        "city": "Brantford",
        "state": "Ontario",
        "zip": "N3P 1A1",
        "is-primary": true,
        "created-at": "2020-01-01T00:00:00+00:00",
        "updated-at": "2020-01-01T00:00:00+00:00"
      },
      "relationships": {
        "user": {
          "data": {
            "type": "users",
            "id": "cu8Eo9RyrUsV4MXEiDZpLM"
          }
        },
        "country": {
          "data": {
            "type": "countries",
            "id": "US"
          }
        }
      }
    }
  ]
}

User Address ¶

This resource retrieves a specified user address instance.

Retrieve User Address
GET`/users/addresses/`

Retrieve an existing user address instance.

Example URI

GET https://api.omnigage.io/api/v1/users/addresses/

Response 200

HideShow

Body

{
  "data": {
    "id": "RaF56o2r58hTKT7AYS9doj",
    "type": "users-addresses",
    "attributes": {
      "label": "Address 1",
      "address1": "94 Tutela Heights Road",
      "address2": null,
      "city": "Brantford",
      "state": "Ontario",
      "zip": "N3P 1A1",
      "is-primary": true,
      "created-at": "2020-01-01T00:00:00+00:00",
      "updated-at": "2020-01-01T00:00:00+00:00"
    },
    "relationships": {
      "user": {
        "data": {
          "type": "users",
          "id": "cu8Eo9RyrUsV4MXEiDZpLM"
        }
      },
      "country": {
        "data": {
          "type": "countries",
          "id": "US"
        }
      }
    }
  }
}

User Phone Collection ¶

This resource manages the retrieval of user phone collections.

Retrieve User Phones
GET`/users/phones{?include,filter,sort,page}`

Retrieve a collection of user phones.

Example URI

GET https://api.omnigage.io/api/v1/users/phones?include=&filter=1&sort=created-at&page=10

URI Parameters

HideShow

include: string (optional)
Include one ore more related relationships using comma separated name.
sort: string (optional) Example: created-at
Sort on one or more fields using comma separated values.
filter: string (optional) Example: 1
Filter on one or more fields using comma separated values filter[field]=1,2.
page: string (optional) Example: 10
Use page[limit]=10 to reduce the number of instances returned. Use ?page[offset]=10 to skip this many instances.

Response 200

HideShow

Body

{
  "links": {
    "self": "/users/cu8Eo9RyrUsV4MXEiDZpLM/phones",
    "next": "/users/cu8Eo9RyrUsV4MXEiDZpLM/phones?page[offset]=10",
    "last": "/users/cu8Eo9RyrUsV4MXEiDZpLM/phones?page[offset]=100"
  },
  "meta": {
    "total": 110
  },
  "data": [
    {
      "id": "RaF56o2r58hTKT7AYS9doj",
      "type": "users-phones",
      "attributes": {
        "label": "Phone 1",
        "phone-number": "+15197566220",
        "is-primary": true,
        "is-confirmed": true,
        "created-at": "2020-01-01T00:00:00+00:00",
        "updated-at": "2020-01-01T00:00:00+00:00"
      },
      "relationships": {
        "user": {
          "data": {
            "type": "users",
            "id": "cu8Eo9RyrUsV4MXEiDZpLM"
          }
        }
      }
    }
  ]
}

User Phone ¶

This resource retrieves a specified user phone instance.

Retrieve User Phone
GET`/users/phones/`

Retrieve an existing user phone instance.

Example URI

GET https://api.omnigage.io/api/v1/users/phones/

Response 200

HideShow

Body

{
  "data": {
    "id": "RaF56o2r58hTKT7AYS9doj",
    "type": "users-phones",
    "attributes": {
      "label": "Phone 1",
      "phone-number": "+15197566220",
      "is-primary": true,
      "is-confirmed": true,
      "created-at": "2020-01-01T00:00:00+00:00",
      "updated-at": "2020-01-01T00:00:00+00:00"
    },
    "relationships": {
      "user": {
        "data": {
          "type": "users",
          "id": "cu8Eo9RyrUsV4MXEiDZpLM"
        }
      }
    }
  }
}

User Email Collection ¶

This resource manages the retrieval of user email collections.

Retrieve User Emails
GET`/users/emails{?include,filter,sort,page}`

Retrieve a collection of user emails.

Example URI

GET https://api.omnigage.io/api/v1/users/emails?include=&filter=1&sort=created-at&page=10

URI Parameters

HideShow

include: string (optional)
Include one ore more related relationships using comma separated name.
sort: string (optional) Example: created-at
Sort on one or more fields using comma separated values.
filter: string (optional) Example: 1
Filter on one or more fields using comma separated values filter[field]=1,2.
page: string (optional) Example: 10
Use page[limit]=10 to reduce the number of instances returned. Use ?page[offset]=10 to skip this many instances.

Response 200

HideShow

Body

{
  "links": {
    "self": "/users/cu8Eo9RyrUsV4MXEiDZpLM/emails",
    "next": "/users/cu8Eo9RyrUsV4MXEiDZpLM/emails?page[offset]=10",
    "last": "/users/cu8Eo9RyrUsV4MXEiDZpLM/emails?page[offset]=100"
  },
  "meta": {
    "total": 110
  },
  "data": [
    {
      "id": "RaF56o2r58hTKT7AYS9doj",
      "type": "users-emails",
      "attributes": {
        "label": "Email 1",
        "email-address": "alexander.bell@bell-labs.com",
        "is-confirmed": true,
        "is-primary": true,
        "created-at": "2020-01-01T00:00:00+00:00",
        "updated-at": "2020-01-01T00:00:00+00:00"
      },
      "relationships": {
        "user": {
          "data": {
            "type": "users",
            "id": "cu8Eo9RyrUsV4MXEiDZpLM"
          }
        }
      }
    }
  ]
}

User Email ¶

This resource retrieves a specified user email instance.

Retrieve User Email
GET`/users/emails/`

Retrieve an existing user email instance.

Example URI

GET https://api.omnigage.io/api/v1/users/emails/

Response 200

HideShow

Body

{
  "data": {
    "id": "RaF56o2r58hTKT7AYS9doj",
    "type": "users-emails",
    "attributes": {
      "label": "Email 1",
      "email-address": "alexander.bell@bell-labs.com",
      "is-confirmed": true,
      "is-primary": true,
      "created-at": "2020-01-01T00:00:00+00:00",
      "updated-at": "2020-01-01T00:00:00+00:00"
    },
    "relationships": {
      "user": {
        "data": {
          "type": "users",
          "id": "cu8Eo9RyrUsV4MXEiDZpLM"
        }
      }
    }
  }
}

Picture ¶

This resource retrieves an individual picture resource with related image files.

Note: Only individual pictures belonging to users of this account can be retrieved.

Retrieve Picture
GET`/pictures/`

Retrieve an existing picture instance.

Example URI

GET https://api.omnigage.io/api/v1/pictures/

Response 200

HideShow

Body

{
  "data": {
    "id": "cu8Eo9RyrUsV4MXEiDZpLM",
    "type": "pictures",
    "attributes": {
      "created-at": "2020-01-01T00:00:00+00:00",
      "updated-at": "2020-01-01T00:00:00+00:00"
    },
    "relationships": {
      "user": {
        "data": {
          "type": "users",
          "id": "vytxeTZskVKR7C7WgdSP3d"
        }
      },
      "thumbnail": {
        "data": {
          "type": "files",
          "id": "wpsWLdLt9nscn2jbTD3uxe"
        }
      },
      "primary": {
        "data": {
          "type": "files",
          "id": "c8sh5y9hdSMS6zVnrvf53T"
        }
      },
      "original": {
        "data": {
          "type": "files",
          "id": "RaF56o2r58hTKT7AYS9doj"
        }
      }
    }
  }
}

Token Collection ¶

This resource manages the retrieval of token collections and the creation of token instances.

Note: An account admin can retrieve, update and delete any instances belonging to an account. A standard membership can only view and change their own instances.

Retrieve Tokens
GET`/tokens{?include,filter,sort,page}`

Retrieve a collection of tokens.

Example URI

GET https://api.omnigage.io/api/v1/tokens?include=&filter=1&sort=created-at&page=10

URI Parameters

HideShow

include: string (optional)
Include one ore more related relationships using comma separated name.
sort: string (optional) Example: created-at
Sort on one or more fields using comma separated values.
filter: string (optional) Example: 1
Filter on one or more fields using comma separated values filter[field]=1,2.
page: string (optional) Example: 10
Use page[limit]=10 to reduce the number of instances returned. Use ?page[offset]=10 to skip this many instances.

Response 200

HideShow

Body

{
  "links": {
    "self": "/tokens",
    "next": "/tokens?page[offset]=10",
    "last": "/tokens?page[offset]=100"
  },
  "meta": {
    "total": 110
  },
  "data": [
    {
      "id": "C8pd8zmNeCCydUAaXXaQZ4",
      "type": "tokens",
      "attributes": {
        "label": "Call, text and email tracking",
        "key": "ohLwXY34ea83ihrx3qZtdu",
        "secret": null,
        "is-archived": false,
        "created-at": "2020-01-01T00:00:00+00:00",
        "updated-at": "2020-01-01T00:00:00+00:00",
        "deleted-at": null
      },
      "relationships": {
        "created-by": {
          "data": {
            "type": "memberships",
            "id": "yxLyyftrAUNWu4qhvefnrf"
          }
        },
        "updated-by": {
          "data": {
            "type": "memberships",
            "id": "yxLyyftrAUNWu4qhvefnrf"
          }
        },
        "deleted-by": {
          "data": null
        }
      }
    }
  ]
}

Create Token
POST`/tokens`

Create a new token instance.

Example URI

POST https://api.omnigage.io/api/v1/tokens

Request

HideShow

Body

{
  "data": {
    "type": "tokens",
    "attributes": {
      "label": "Call, text and email tracking"
    }
  }
}

Response 201

HideShow

Body

{
  "data": {
    "id": "C8pd8zmNeCCydUAaXXaQZ4",
    "type": "tokens",
    "attributes": {
      "label": "Call, text and email tracking",
      "key": "ohLwXY34ea83ihrx3qZtdu",
      "secret": "zIyoaTKpB5VzsKt1cl9pKC",
      "is-archived": false,
      "created-at": "2020-01-01T00:00:00+00:00",
      "updated-at": "2020-01-01T00:00:00+00:00",
      "deleted-at": null
    },
    "relationships": {
      "created-by": {
        "data": {
          "type": "memberships",
          "id": "yxLyyftrAUNWu4qhvefnrf"
        }
      },
      "updated-by": {
        "data": {
          "type": "memberships",
          "id": "yxLyyftrAUNWu4qhvefnrf"
        }
      },
      "deleted-by": {
        "data": null
      }
    }
  }
}

Token ¶

This resource manages updating, retrieving and deleting a specified token instance.

Authenticating using a token follows Basic Authentication as defined by RFC 2617. Note: https is required.

Example: cURL

curl -u key:secret https://api.omnigage.io/v1/calls

Example: Request Header

Authorization: Basic a2V5OnNlY3JldA==

Retrieve Token
GET`/tokens/`

Retrieve an existing token instance.

Example URI

GET https://api.omnigage.io/api/v1/tokens/

Response 200

HideShow

Body

{
  "data": {
    "id": "C8pd8zmNeCCydUAaXXaQZ4",
    "type": "tokens",
    "attributes": {
      "label": "Call, text and email tracking",
      "key": "ohLwXY34ea83ihrx3qZtdu",
      "secret": null,
      "is-archived": false,
      "created-at": "2020-01-01T00:00:00+00:00",
      "updated-at": "2020-01-01T00:00:00+00:00",
      "deleted-at": null
    },
    "relationships": {
      "created-by": {
        "data": {
          "type": "memberships",
          "id": "yxLyyftrAUNWu4qhvefnrf"
        }
      },
      "updated-by": {
        "data": {
          "type": "memberships",
          "id": "yxLyyftrAUNWu4qhvefnrf"
        }
      },
      "deleted-by": {
        "data": null
      }
    }
  }
}

Update Token
PATCH`/tokens/`

Update an existing token instance.

Example URI

PATCH https://api.omnigage.io/api/v1/tokens/

Request

HideShow

Body

{
  "data": {
    "id": "C8pd8zmNeCCydUAaXXaQZ4",
    "type": "tokens",
    "attributes": {
      "label": "Call, text and email tracking",
      "key": "ohLwXY34ea83ihrx3qZtdu",
      "secret": null,
      "is-archived": false,
      "created-at": "2020-01-01T00:00:00+00:00",
      "updated-at": "2020-01-01T00:00:00+00:00",
      "deleted-at": null
    },
    "relationships": {
      "created-by": {
        "data": {
          "type": "memberships",
          "id": "yxLyyftrAUNWu4qhvefnrf"
        }
      },
      "updated-by": {
        "data": {
          "type": "memberships",
          "id": "yxLyyftrAUNWu4qhvefnrf"
        }
      },
      "deleted-by": {
        "data": null
      }
    }
  }
}

Response 202

HideShow

Body

{
  "data": {
    "id": "C8pd8zmNeCCydUAaXXaQZ4",
    "type": "tokens",
    "attributes": {
      "label": "Call, text and email tracking",
      "key": "ohLwXY34ea83ihrx3qZtdu",
      "secret": null,
      "is-archived": false,
      "created-at": "2020-01-01T00:00:00+00:00",
      "updated-at": "2020-01-01T00:00:00+00:00",
      "deleted-at": null
    },
    "relationships": {
      "created-by": {
        "data": {
          "type": "memberships",
          "id": "yxLyyftrAUNWu4qhvefnrf"
        }
      },
      "updated-by": {
        "data": {
          "type": "memberships",
          "id": "yxLyyftrAUNWu4qhvefnrf"
        }
      },
      "deleted-by": {
        "data": null
      }
    }
  }
}

Delete Token
DELETE`/tokens/`

Sets the is-archived field’s value to true. The token will no longer be active.

Example URI

DELETE https://api.omnigage.io/api/v1/tokens/

Response 204

Geographic Resources ¶

Country Collection ¶

This resource manages the retrieval of country collections.

Retrieve Countries
GET`/countries{?include,filter,sort,page}`

Retrieve a collection of countries.

Example URI

GET https://api.omnigage.io/api/v1/countries?include=&filter=1&sort=created-at&page=10

URI Parameters

HideShow

include: string (optional)
Include one ore more related relationships using comma separated name.
sort: string (optional) Example: created-at
Sort on one or more fields using comma separated values.
filter: string (optional) Example: 1
Filter on one or more fields using comma separated values filter[field]=1,2.
page: string (optional) Example: 10
Use page[limit]=10 to reduce the number of instances returned. Use ?page[offset]=10 to skip this many instances.

Response 200

HideShow

Body

{
  "links": {
    "self": "/countries",
    "next": "/countries?page[offset]=10",
    "last": "/countries?page[offset]=100"
  },
  "meta": {
    "total": 195
  },
  "data": [
    {
      "id": "US",
      "type": "countries",
      "attributes": {
        "label": "United States"
      }
    }
  ]
}

Country ¶

This resource retrieves a specified country instance.

Retrieve Country
GET`/countries/`

Retrieve an existing country instance.

Example URI

GET https://api.omnigage.io/api/v1/countries/

Response 200

HideShow

Body

{
  "data": {
    "id": "US",
    "type": "countries",
    "attributes": {
      "label": "United States"
    }
  }
}

Time Zone Collection ¶

This resource manages the retrieval of time zone collections.

Retrieve Time Zones
GET`/timezones{?include,filter,sort,page}`

Retrieve a collection of timezones.

Example URI

GET https://api.omnigage.io/api/v1/timezones?include=&filter=1&sort=created-at&page=10

URI Parameters

HideShow

include: string (optional)
Include one ore more related relationships using comma separated name.
sort: string (optional) Example: created-at
Sort on one or more fields using comma separated values.
filter: string (optional) Example: 1
Filter on one or more fields using comma separated values filter[field]=1,2.
page: string (optional) Example: 10
Use page[limit]=10 to reduce the number of instances returned. Use ?page[offset]=10 to skip this many instances.

Response 200

HideShow

Body

{
  "links": {
    "self": "/timezones",
    "next": "/timezones?page[offset]=10",
    "last": "/timezones?page[offset]=100"
  },
  "meta": {
    "total": 582
  },
  "data": [
    {
      "id": "cu8Eo9RyrUsV4MXEiDZpLM",
      "type": "timezones",
      "attributes": {
        "name": "US/Eastern",
        "offset": "UTC−05:00",
        "is-featured": true
      }
    }
  ]
}

Time Zone ¶

This resource retrieves a specified time zone instance.

Retrieve Time Zone
GET`/timezones/`

Retrieve an existing time zone instance.

Example URI

GET https://api.omnigage.io/api/v1/timezones/

Response 200

HideShow

Body

{
  "data": {
    "id": "cu8Eo9RyrUsV4MXEiDZpLM",
    "type": "timezones",
    "attributes": {
      "name": "America/New_York",
      "offset": "UTC−05:00",
      "is-featured": true
    }
  }
}

Media Resources ¶

Upload ¶

An upload is pre-signed form inputs to upload directly to AWS S3. The response is structured to facilitate creating a multipart/form-data form submission.

How uploads work:

Creating an upload returns pre-signed form inputs for uploading directly to AWS S3
Each upload is single use
Once the form submission to S3 is complete, the upload id is to be used as a relationship with another resource. Consult corresponding API blueprint documentation for how the resource expects to receive the upload id.
Uploads do expire based on the date indicated in the response. Uploads not used are cleaned up; therefore, if the upload id is not bound to a resource the media will be permanently deleted.

Create an Upload
POST`/uploads`

To create pre-signed upload credentials, simply POST (request body not required). Then use the form action, method and inputs in the response to construct a multipart/form-data submission with the included media. NOTE: The Content-Type input is required in addition to the inputs provided herein.

Example URI

POST https://api.omnigage.io/api/v1/uploads

Response 201

HideShow

Headers

Content-Type: application/json

Body

{
  "data": {
    "type": "uploads",
    "id": "wpsWLdLt9nscn2jbTD3uxe",
    "attributes": {
      "expires-at": "Thu, 15 Oct 2020 05:21:18 GMT",
      "max-length-in-bytes": 5368724480,
      "request-url": "//project-environment-media.s3.amazonaws.com/",
      "request-method": "post",
      "request-headers": [
        {
          "x-amz-server-side-encryption": "AES256"
        }
      ],
      "request-form-data": [
        {
          "acl": "private"
        },
        {
          "AWSAccessKeyId": "AKIAJMNZNYJMKJTOJYUA"
        },
        {
          "key": "uploads/15f057a487674e2e9557336d7a4e9592/${filename}"
        },
        {
          "policy": "eyJjb25kaXRpb25zIjogW3siYWN..."
        },
        {
          "signature": "WZkSKje4piwdmTd2xGs3VHFq5GQ="
        }
      ]
    }
  }
}

File ¶

This resource manages retrieving a specified file instance.

Note: Only individual files belonging to this account can be retrieved.

Retrieve File
GET`/files/`

Retrieve an existing file instance.

Example URI

GET https://api.omnigage.io/api/v1/files/

Request

HideShow

Body

{
    "data": {
        "id": "vytxeTZskVKR7C7WgdSP3d",
        "type": "files",
        "attributes": {
            "url": "//aws.amazon.com/bucket/2982$gg.png",
            "size-in-bytes": 5368724480,
            "content-type": "image/png"
            "width": 150,
            "height": 120,
            "created-at": "2020-01-01T00:00:00+00:00",
            "updated-at": "2020-01-01T00:00:00+00:00"
        }
    }
}

Response 200

HideShow

Body

{
    "data": {
        "id": "vytxeTZskVKR7C7WgdSP3d",
        "type": "files",
        "attributes": {
            "url": "//aws.amazon.com/bucket/2982$gg.png",
            "size-in-bytes": 5368724480,
            "content-type": "image/png"
            "width": 150,
            "height": 120,
            "created-at": "2020-01-01T00:00:00+00:00",
            "updated-at": "2020-01-01T00:00:00+00:00"
        }
    }
}

Delete File
DELETE`/files/`

Sets the is-archived field’s value to true. Note: The actual instance is not deleted. When the file is archived, versioned resources, with that file as a relationship, are revised to no longer carry the archived file relationship.

Example URI

DELETE https://api.omnigage.io/api/v1/files/

Response 204

Engagement Resources ¶

Engagement Collection ¶

This resource manages the retrieval of engagement collections and the creation of engagement instances.

Retrieve Engagements
GET`/engagements{?include,filter,sort,page}`

Retrieve a collection of engagements.

Example URI

GET https://api.omnigage.io/api/v1/engagements?include=&filter=1&sort=created-at&page=10

URI Parameters

HideShow

include: string (optional)
Include one ore more related relationships using comma separated name.
sort: string (optional) Example: created-at
Sort on one or more fields using comma separated values.
filter: string (optional) Example: 1
Filter on one or more fields using comma separated values filter[field]=1,2.
page: string (optional) Example: 10
Use page[limit]=10 to reduce the number of instances returned. Use ?page[offset]=10 to skip this many instances.

Response 200

HideShow

Body

{
  "links": {
    "self": "/engagements",
    "next": "/engagements?page[offset]=10",
    "last": "/engagements?page[offset]=100"
  },
  "meta": {
    "total": 110
  },
  "data": [
    {
      "id": "cu8Eo9RyrUsV4MXEiDZpLM",
      "type": "engagements",
      "attributes": {
        "name": "Flash Sale - Top Buyers",
        "status": "pending",
        "direction": "outbound",
        "count-total": 1270,
        "count-complete": 300,
        "count-incomplete": 240,
        "count-hold": 7,
        "delivery-type": "scheduled",
        "delivery-time": "2020-09-09T16:30+00:00",
        "delivery-compliance-is-approved": false,
        "queue-kind": "batch",
        "queue-batch-limit": 100,
        "queue-progressive-ratio": "1:4",
        "queue-throttle-hold-limit": 10,
        "queue-throttle-day-limit": 1000,
        "queue-throttle-hour-limit": 100,
        "queue-schedule-is-enabled": false,
        "queue-schedule": {},
        "is-archived": false,
        "created-at": "2020-01-01T00:00:00+00:00",
        "updated-at": "2020-01-01T00:00:00+00:00",
        "deleted-at": null
      },
      "relationships": {
        "lists": {
          "data": [
            {
              "type": "lists",
              "id": "QYQdq5qYLLQsT42MKFg6fQ"
            },
            {
              "type": "lists",
              "id": "v9kNKBNojpUsrtgtJ7LE3V"
            }
          ]
        },
        "activity": {
          "data": {
            "type": "activities",
            "id": "wpsWLdLt9nscn2jbTD3uxe"
          }
        },
        "latest-review": {
          "data": {
            "type": "reviews",
            "id": "y9hdSMS6zc8sh5Vnrvf53T"
          }
        },
        "reviews": {
          "links": {
            "related": "/engagements/cu8Eo9RyrUsV4MXEiDZpLM/reviews"
          }
        },
        "phone-numbers": {
          "data": [
            {
              "type": "phone-numbers",
              "id": "yJQBZzodQKxtKZV7sMYJuZ"
            }
          ]
        },
        "caller-ids": {
          "data": [
            {
              "type": "caller-ids",
              "id": "QHns3Q2rxwUEuu2spJJYEA"
            }
          ]
        },
        "email-ids": {
          "data": [
            {
              "type": "email-ids",
              "id": "qAfqpKPE9yjE252xqtL76U"
            }
          ]
        },
        "created-by": {
          "data": {
            "type": "memberships",
            "id": "C7xWERND6yBTpJJVHACzVf"
          }
        },
        "updated-by": {
          "data": {
            "type": "memberships",
            "id": "C7xWERND6yBTpJJVHACzVf"
          }
        },
        "deleted-by": {
          "data": null
        }
      }
    }
  ]
}

Create Engagement
POST`/engagements`

Create a new engagement instance.

Example URI

POST https://api.omnigage.io/api/v1/engagements

Request

HideShow

Body

{
  "data": {
    "type": "engagements",
    "attributes": {
      "name": "Flash Sale - Top Buyers"
    },
    "relationships": {
      "lists": {
        "data": [
          {
            "type": "lists",
            "id": "QYQdq5qYLLQsT42MKFg6fQ"
          },
          {
            "type": "lists",
            "id": "v9kNKBNojpUsrtgtJ7LE3V"
          }
        ]
      }
    }
  }
}

Response 201

HideShow

Body

{
  "data": {
    "id": "cu8Eo9RyrUsV4MXEiDZpLM",
    "type": "engagements",
    "attributes": {
      "name": "Flash Sale - Top Buyers",
      "status": "pending",
      "direction": "outbound",
      "count-total": 1270,
      "count-complete": 300,
      "count-incomplete": 240,
      "count-hold": 7,
      "delivery-type": "immediately",
      "delivery-time": null,
      "delivery-compliance-is-approved": true,
      "queue-kind": "batch",
      "queue-batch-limit": 100,
      "queue-progressive-ratio": "1:4",
      "queue-throttle-hold-limit": 10,
      "queue-throttle-day-limit": 1000,
      "queue-throttle-hour-limit": 100,
      "queue-schedule-is-enabled": true,
      "queue-schedule": {
        "monday": [
          {
            "from": "05:00",
            "to": "17:00"
          }
        ],
        "friday": [
          {
            "from": "08:00",
            "to": "14:59"
          }
        ]
      },
      "is-archived": false,
      "created-at": "2020-01-01T00:00:00+00:00",
      "updated-at": "2020-01-01T00:00:00+00:00",
      "deleted-at": null
    },
    "relationships": {
      "lists": {
        "data": [
          {
            "type": "lists",
            "id": "QYQdq5qYLLQsT42MKFg6fQ"
          },
          {
            "type": "lists",
            "id": "v9kNKBNojpUsrtgtJ7LE3V"
          }
        ]
      },
      "activity": {
        "data": {
          "type": "activities",
          "id": "wpsWLdLt9nscn2jbTD3uxe"
        }
      },
      "latest-review": {
        "data": {
          "type": "reviews",
          "id": "y9hdSMS6zc8sh5Vnrvf53T"
        }
      },
      "reviews": {
        "links": {
          "related": "/engagements/cu8Eo9RyrUsV4MXEiDZpLM/reviews"
        }
      },
      "phone-numbers": {
        "data": [
          {
            "type": "phone-numbers",
            "id": "yJQBZzodQKxtKZV7sMYJuZ"
          }
        ]
      },
      "caller-ids": {
        "data": [
          {
            "type": "caller-ids",
            "id": "QHns3Q2rxwUEuu2spJJYEA"
          }
        ]
      },
      "email-ids": {
        "data": [
          {
            "type": "email-ids",
            "id": "qAfqpKPE9yjE252xqtL76U"
          }
        ]
      },
      "created-by": {
        "data": {
          "type": "memberships",
          "id": "C7xWERND6yBTpJJVHACzVf"
        }
      },
      "updated-by": {
        "data": {
          "type": "memberships",
          "id": "C7xWERND6yBTpJJVHACzVf"
        }
      },
      "deleted-by": {
        "data": null
      }
    }
  }
}

Engagement ¶

This resource manages updating, retrieving and deleting a specified engagement instance.

An engagement and related activities can only be modified when the engagement has the status of pending or review-declined.
A status of closed or canceled cannot be changed. The engagement is single use.

Note: When an engagement status becomes processing, the content revision ids are set accordingly: - If the engagement is coupled with a review, the revision ids are derived from the approved revision. - If the engagement is not associated to a review, the latest revision ids are used.

Retrieve Engagement
GET`/engagements/`

Retrieve an existing engagement instance.

Example URI

GET https://api.omnigage.io/api/v1/engagements/

Response 200

HideShow

Body

{
  "data": {
    "id": "cu8Eo9RyrUsV4MXEiDZpLM",
    "type": "engagements",
    "attributes": {
      "name": "Flash Sale - Top Buyers",
      "status": "pending",
      "direction": "outbound",
      "count-total": 1270,
      "count-complete": 300,
      "count-incomplete": 240,
      "count-hold": 7,
      "delivery-type": "immediately",
      "delivery-time": null,
      "delivery-compliance-is-approved": true,
      "queue-kind": "batch",
      "queue-batch-limit": 100,
      "queue-progressive-ratio": "1:4",
      "queue-throttle-hold-limit": 10,
      "queue-throttle-day-limit": 1000,
      "queue-throttle-hour-limit": 100,
      "queue-schedule-is-enabled": true,
      "queue-schedule": {
        "monday": [
          {
            "from": "05:00",
            "to": "17:00"
          }
        ],
        "friday": [
          {
            "from": "08:00",
            "to": "14:59"
          }
        ]
      },
      "is-archived": false,
      "created-at": "2020-01-01T00:00:00+00:00",
      "updated-at": "2020-01-01T00:00:00+00:00",
      "deleted-at": null
    },
    "relationships": {
      "lists": {
        "data": [
          {
            "type": "lists",
            "id": "QYQdq5qYLLQsT42MKFg6fQ"
          },
          {
            "type": "lists",
            "id": "v9kNKBNojpUsrtgtJ7LE3V"
          }
        ]
      },
      "activity": {
        "data": {
          "type": "activities",
          "id": "wpsWLdLt9nscn2jbTD3uxe"
        }
      },
      "latest-review": {
        "data": {
          "type": "reviews",
          "id": "y9hdSMS6zc8sh5Vnrvf53T"
        }
      },
      "reviews": {
        "links": {
          "related": "/engagements/cu8Eo9RyrUsV4MXEiDZpLM/reviews"
        }
      },
      "phone-numbers": {
        "data": [
          {
            "type": "phone-numbers",
            "id": "yJQBZzodQKxtKZV7sMYJuZ"
          }
        ]
      },
      "caller-ids": {
        "data": [
          {
            "type": "caller-ids",
            "id": "QHns3Q2rxwUEuu2spJJYEA"
          }
        ]
      },
      "email-ids": {
        "data": [
          {
            "type": "email-ids",
            "id": "qAfqpKPE9yjE252xqtL76U"
          }
        ]
      },
      "created-by": {
        "data": {
          "type": "memberships",
          "id": "C7xWERND6yBTpJJVHACzVf"
        }
      },
      "updated-by": {
        "data": {
          "type": "memberships",
          "id": "C7xWERND6yBTpJJVHACzVf"
        }
      },
      "deleted-by": {
        "data": null
      }
    }
  }
}

Update Engagement
PATCH`/engagements/`

Update an existing engagement instance.

Example URI

PATCH https://api.omnigage.io/api/v1/engagements/

Request

HideShow

Body

{
  "data": {
    "id": "cu8Eo9RyrUsV4MXEiDZpLM",
    "type": "engagements",
    "attributes": {
      "name": "Flash Sale - Top Buyers",
      "status": "pending",
      "direction": "outbound",
      "count-total": 1270,
      "count-complete": 300,
      "count-incomplete": 240,
      "count-hold": 7,
      "delivery-type": "immediately",
      "delivery-time": null,
      "delivery-compliance-is-approved": true,
      "queue-kind": "batch",
      "queue-batch-limit": 100,
      "queue-progressive-ratio": "1:4",
      "queue-throttle-hold-limit": 10,
      "queue-throttle-day-limit": 1000,
      "queue-throttle-hour-limit": 100,
      "queue-schedule-is-enabled": true,
      "queue-schedule": {
        "monday": [
          {
            "from": "05:00",
            "to": "17:00"
          }
        ],
        "friday": [
          {
            "from": "08:00",
            "to": "14:59"
          }
        ]
      },
      "is-archived": false,
      "created-at": "2020-01-01T00:00:00+00:00",
      "updated-at": "2020-01-01T00:00:00+00:00",
      "deleted-at": null
    },
    "relationships": {
      "lists": {
        "data": [
          {
            "type": "lists",
            "id": "QYQdq5qYLLQsT42MKFg6fQ"
          },
          {
            "type": "lists",
            "id": "v9kNKBNojpUsrtgtJ7LE3V"
          }
        ]
      },
      "activity": {
        "data": {
          "type": "activities",
          "id": "wpsWLdLt9nscn2jbTD3uxe"
        }
      },
      "latest-review": {
        "data": {
          "type": "reviews",
          "id": "y9hdSMS6zc8sh5Vnrvf53T"
        }
      },
      "reviews": {
        "links": {
          "related": "/engagements/cu8Eo9RyrUsV4MXEiDZpLM/reviews"
        }
      },
      "phone-numbers": {
        "data": [
          {
            "type": "phone-numbers",
            "id": "yJQBZzodQKxtKZV7sMYJuZ"
          }
        ]
      },
      "caller-ids": {
        "data": [
          {
            "type": "caller-ids",
            "id": "QHns3Q2rxwUEuu2spJJYEA"
          }
        ]
      },
      "email-ids": {
        "data": [
          {
            "type": "email-ids",
            "id": "qAfqpKPE9yjE252xqtL76U"
          }
        ]
      },
      "created-by": {
        "data": {
          "type": "memberships",
          "id": "C7xWERND6yBTpJJVHACzVf"
        }
      },
      "updated-by": {
        "data": {
          "type": "memberships",
          "id": "C7xWERND6yBTpJJVHACzVf"
        }
      },
      "deleted-by": {
        "data": null
      }
    }
  }
}

Response 202

HideShow

Body

{
  "data": {
    "id": "cu8Eo9RyrUsV4MXEiDZpLM",
    "type": "engagements",
    "attributes": {
      "name": "Flash Sale - Top Buyers",
      "status": "pending",
      "direction": "outbound",
      "count-total": 1270,
      "count-complete": 300,
      "count-incomplete": 240,
      "count-hold": 7,
      "delivery-type": "immediately",
      "delivery-time": null,
      "delivery-compliance-is-approved": true,
      "queue-kind": "batch",
      "queue-batch-limit": 100,
      "queue-progressive-ratio": "1:4",
      "queue-throttle-hold-limit": 10,
      "queue-throttle-day-limit": 1000,
      "queue-throttle-hour-limit": 100,
      "queue-schedule-is-enabled": true,
      "queue-schedule": {
        "monday": [
          {
            "from": "05:00",
            "to": "17:00"
          }
        ],
        "friday": [
          {
            "from": "08:00",
            "to": "14:59"
          }
        ]
      },
      "is-archived": false,
      "created-at": "2020-01-01T00:00:00+00:00",
      "updated-at": "2020-01-01T00:00:00+00:00",
      "deleted-at": null
    },
    "relationships": {
      "lists": {
        "data": [
          {
            "type": "lists",
            "id": "QYQdq5qYLLQsT42MKFg6fQ"
          },
          {
            "type": "lists",
            "id": "v9kNKBNojpUsrtgtJ7LE3V"
          }
        ]
      },
      "activity": {
        "data": {
          "type": "activities",
          "id": "wpsWLdLt9nscn2jbTD3uxe"
        }
      },
      "latest-review": {
        "data": {
          "type": "reviews",
          "id": "y9hdSMS6zc8sh5Vnrvf53T"
        }
      },
      "reviews": {
        "links": {
          "related": "/engagements/cu8Eo9RyrUsV4MXEiDZpLM/reviews"
        }
      },
      "phone-numbers": {
        "data": [
          {
            "type": "phone-numbers",
            "id": "yJQBZzodQKxtKZV7sMYJuZ"
          }
        ]
      },
      "caller-ids": {
        "data": [
          {
            "type": "caller-ids",
            "id": "QHns3Q2rxwUEuu2spJJYEA"
          }
        ]
      },
      "email-ids": {
        "data": [
          {
            "type": "email-ids",
            "id": "qAfqpKPE9yjE252xqtL76U"
          }
        ]
      },
      "created-by": {
        "data": {
          "type": "memberships",
          "id": "C7xWERND6yBTpJJVHACzVf"
        }
      },
      "updated-by": {
        "data": {
          "type": "memberships",
          "id": "C7xWERND6yBTpJJVHACzVf"
        }
      },
      "deleted-by": {
        "data": null
      }
    }
  }
}

Delete Engagement
DELETE`/engagements/`

This implicitly archives the instance by setting is-archived to true. The actual instance is not deleted.

Example URI

DELETE https://api.omnigage.io/api/v1/engagements/

Response 204

Engagement Collaborator Collection ¶

This resource manages the retrieval of collaborator collections and the creation of collaborator instances.

Retrieve Engagement Collaborators
GET`/engagements/collaborators{?include,sort,filter,page}`

Retrieve a collection of collaborators.

Example URI

GET https://api.omnigage.io/api/v1/engagements/collaborators?include=&sort=created-at&filter=1&page=10

URI Parameters

HideShow

include: string (optional)
Include one ore more related relationships using comma separated name.
sort: string (optional) Example: created-at
Sort on one or more fields using comma separated values.
filter: string (optional) Example: 1
Filter on one or more fields using comma separated values filter[field]=1,2.
page: string (optional) Example: 10
Use page[limit]=10 to reduce the number of instances returned. Use ?page[offset]=10 to skip this many instances.

Response 200

HideShow

Body

{
  "links": {
    "self": "/engagements/qYjByDBTXZKZam9TLJonvf/collaborators",
    "next": "/engagements/qYjByDBTXZKZam9TLJonvf/collaborators?page[offset]=10",
    "last": "/engagements/qYjByDBTXZKZam9TLJonvf/collaborators?page[offset]=100"
  },
  "meta": {
    "total": 1
  },
  "data": [
    {
      "id": "RaF56o2r58hTKT7AYS9doj",
      "type": "engagements-collaborators",
      "attributes": {
        "permission": "write",
        "is-archived": false,
        "created-at": "2020-01-01T00:00:00+00:00",
        "updated-at": "2020-01-01T00:00:00+00:00",
        "deleted-at": null
      },
      "relationships": {
        "membership": {
          "data": {
            "type": "memberships",
            "id": "6jVhCt5kE2p6e7B7SX9CGe"
          }
        },
        "team": {
          "data": null
        },
        "engagement": {
          "data": {
            "type": "engagements",
            "id": "qYjByDBTXZKZam9TLJonvf"
          }
        },
        "created-by": {
          "data": {
            "type": "memberships",
            "id": "C7xWERND6yBTpJJVHACzVf"
          }
        },
        "updated-by": {
          "data": {
            "type": "memberships",
            "id": "C7xWERND6yBTpJJVHACzVf"
          }
        },
        "deleted-by": {
          "data": null
        }
      }
    }
  ]
}

Create Engagement Collaborator
POST`/engagements/collaborators`

Create a new collaborator instance.

Example URI

POST https://api.omnigage.io/api/v1/engagements/collaborators

Request

HideShow

Body

{
  "data": {
    "type": "engagements-collaborators",
    "attributes": {
      "permission": "write"
    },
    "relationships": {
      "membership": {
        "data": {
          "type": "memberships",
          "id": "6jVhCt5kE2p6e7B7SX9CGe"
        }
      },
      "engagement": {
        "data": {
          "type": "engagements",
          "id": "qYjByDBTXZKZam9TLJonvf"
        }
      }
    }
  }
}

Response 201

HideShow

Body

{
  "data": {
    "id": "RaF56o2r58hTKT7AYS9doj",
    "type": "engagements-collaborators",
    "attributes": {
      "permission": "write",
      "is-archived": false,
      "created-at": "2020-01-01T00:00:00+00:00",
      "updated-at": "2020-01-01T00:00:00+00:00",
      "deleted-at": null
    },
    "relationships": {
      "membership": {
        "data": {
          "type": "memberships",
          "id": "6jVhCt5kE2p6e7B7SX9CGe"
        }
      },
      "team": {
        "data": null
      },
      "engagement": {
        "data": {
          "type": "engagements",
          "id": "qYjByDBTXZKZam9TLJonvf"
        }
      },
      "created-by": {
        "data": {
          "type": "memberships",
          "id": "C7xWERND6yBTpJJVHACzVf"
        }
      },
      "updated-by": {
        "data": {
          "type": "memberships",
          "id": "C7xWERND6yBTpJJVHACzVf"
        }
      },
      "deleted-by": {
        "data": null
      }
    }
  }
}

Engagement Collaborator ¶

This resource manages updating and retrieving a specified collaborator instance.

Retrieve Engagement Collaborator
GET`/engagements/collaborators/`

Retrieve an existing collaborator instance.

Example URI

GET https://api.omnigage.io/api/v1/engagements/collaborators/

Response 200

HideShow

Body

{
  "data": {
    "id": "RaF56o2r58hTKT7AYS9doj",
    "type": "engagements-collaborators",
    "attributes": {
      "permission": "write",
      "is-archived": false,
      "created-at": "2020-01-01T00:00:00+00:00",
      "updated-at": "2020-01-01T00:00:00+00:00",
      "deleted-at": null
    },
    "relationships": {
      "membership": {
        "data": {
          "type": "memberships",
          "id": "6jVhCt5kE2p6e7B7SX9CGe"
        }
      },
      "team": {
        "data": null
      },
      "engagement": {
        "data": {
          "type": "engagements",
          "id": "qYjByDBTXZKZam9TLJonvf"
        }
      },
      "created-by": {
        "data": {
          "type": "memberships",
          "id": "C7xWERND6yBTpJJVHACzVf"
        }
      },
      "updated-by": {
        "data": {
          "type": "memberships",
          "id": "C7xWERND6yBTpJJVHACzVf"
        }
      },
      "deleted-by": {
        "data": null
      }
    }
  }
}

Update Engagement Collaborator
PATCH`/engagements/collaborators/`

Update an existing collaborator instance.

Note: A membership cannot edit their own instance.

Example URI

PATCH https://api.omnigage.io/api/v1/engagements/collaborators/

Request

HideShow

Body

{
  "data": {
    "id": "RaF56o2r58hTKT7AYS9doj",
    "type": "engagements-collaborators",
    "attributes": {
      "permission": "write",
      "is-archived": false,
      "created-at": "2020-01-01T00:00:00+00:00",
      "updated-at": "2020-01-01T00:00:00+00:00",
      "deleted-at": null
    },
    "relationships": {
      "membership": {
        "data": {
          "type": "memberships",
          "id": "6jVhCt5kE2p6e7B7SX9CGe"
        }
      },
      "team": {
        "data": null
      },
      "engagement": {
        "data": {
          "type": "engagements",
          "id": "qYjByDBTXZKZam9TLJonvf"
        }
      },
      "created-by": {
        "data": {
          "type": "memberships",
          "id": "C7xWERND6yBTpJJVHACzVf"
        }
      },
      "updated-by": {
        "data": {
          "type": "memberships",
          "id": "C7xWERND6yBTpJJVHACzVf"
        }
      },
      "deleted-by": {
        "data": null
      }
    }
  }
}

Response 202

HideShow

Body

{
  "data": {
    "id": "RaF56o2r58hTKT7AYS9doj",
    "type": "engagements-collaborators",
    "attributes": {
      "permission": "write",
      "is-archived": false,
      "created-at": "2020-01-01T00:00:00+00:00",
      "updated-at": "2020-01-01T00:00:00+00:00",
      "deleted-at": null
    },
    "relationships": {
      "membership": {
        "data": {
          "type": "memberships",
          "id": "6jVhCt5kE2p6e7B7SX9CGe"
        }
      },
      "team": {
        "data": null
      },
      "engagement": {
        "data": {
          "type": "engagements",
          "id": "qYjByDBTXZKZam9TLJonvf"
        }
      },
      "created-by": {
        "data": {
          "type": "memberships",
          "id": "C7xWERND6yBTpJJVHACzVf"
        }
      },
      "updated-by": {
        "data": {
          "type": "memberships",
          "id": "C7xWERND6yBTpJJVHACzVf"
        }
      },
      "deleted-by": {
        "data": null
      }
    }
  }
}

Delete Engagement Collaborator
DELETE`/engagements/collaborators/`

Sets the is-archived field’s value to true. Note: The actual instance is not deleted.

Note: A membership cannot delete their own instance.

Example URI

DELETE https://api.omnigage.io/api/v1/engagements/collaborators/

Response 204

Engagement Review Collection ¶

This resource manages the retrieval of a given engagement’s reviews.

Retrieve Engagement Reviews
GET`/engagements/reviews{?include,filter,sort,page}`

Retrieve a collection of engagement reviews.

Example URI

GET https://api.omnigage.io/api/v1/engagements/reviews?include=&filter=1&sort=created-at&page=10

URI Parameters

HideShow

include: string (optional)
Include one ore more related relationships using comma separated name.
sort: string (optional) Example: created-at
Sort on one or more fields using comma separated values.
filter: string (optional) Example: 1
Filter on one or more fields using comma separated values filter[field]=1,2.
page: string (optional) Example: 10
Use page[limit]=10 to reduce the number of instances returned. Use ?page[offset]=10 to skip this many instances.

Response 200

HideShow

Body

{
    "links": {
        "self": "/reviews",
        "next": "/reviews?page[offset]=10",
        "last": "/reviews?page[offset]=100"
    },
    "meta": {
        "total": 110
    },
    "data": [{
        "id": "c8sh5y9hdSMS6zVnrvf53T",
        "type": "reviews",
        "attributes": {
            "name": "Fall Specials",
            "status": "pending",
            "compliance-kind": "pre",
            "kind": "engagement",
            "content-count": 4,
            "is-archived": false,
            "created-at": "2020-01-01T00:00:00+00:00",
            "updated-at": "2020-01-01T00:00:00+00:00"
        },
        "relationships": {
            "comments": {
                "links": {
                    "related": "/reviews/c8sh5y9hdSMS6zVnrvf53T/comments"
                }
            },
            "engagement": {
                "data": {"type": "engagements", "id": "Vnrvf53Tc8shdSMS6zh5y9"}
            },
            "email-templates": {
                "data": [
                    {"type": "email-templates", "id": "ZskVKR7C7WgdvytxeTSP3d"},
                    {"type": "email-templates", "id": "Vnrvf53Tc8shdSMS6zh5y9"}
                ]
            }
            "voice-templates": {
                "data": [
                    {"type": "voice-templates", "id": "r58hTKT7AYS9dojRaF56o2"}
                ]
            }
            "text-templates": {
                "data": [
                    {"type": "text-templates", "id": "KR7C7WgdvytxeTSP3dZskV"}
                ]
            },
            "page": {
                "data": null
            },
            "post": {
                "data": null
            },
            "created-by": {
                "data": {"type": "memberships", "id": "C7xWERND6yBTpJJVHACzVf"}
            },
            "updated-by": {
                "data": {"type": "memberships", "id": "C7xWERND6yBTpJJVHACzVf"}
            }
        }
    }]
}

Engagement Review ¶

This resource manages retrieving a specified engagement review instance.

Retrieve Engagement Review
GET`/engagements/reviews/`

Retrieve an existing engagement review instance.

Example URI

GET https://api.omnigage.io/api/v1/engagements/reviews/

Response 200

HideShow

Body

{
    "data": {
        "id": "c8sh5y9hdSMS6zVnrvf53T",
        "type": "reviews",
        "attributes": {
            "name": "Fall Specials",
            "status": "pending",
            "compliance-kind": "pre",
            "kind": "engagement",
            "content-count": 4,
            "is-archived": false,
            "created-at": "2020-01-01T00:00:00+00:00",
            "updated-at": "2020-01-01T00:00:00+00:00"
        },
        "relationships": {
            "comments": {
                "links": {
                    "related": "/reviews/c8sh5y9hdSMS6zVnrvf53T/comments"
                }
            },
            "engagement": {
                "data": {"type": "engagements", "id": "Vnrvf53Tc8shdSMS6zh5y9"}
            },
            "email-templates": {
                "data": [
                    {"type": "email-templates", "id": "ZskVKR7C7WgdvytxeTSP3d"},
                    {"type": "email-templates", "id": "Vnrvf53Tc8shdSMS6zh5y9"}
                ]
            }
            "voice-templates": {
                "data": [
                    {"type": "voice-templates", "id": "r58hTKT7AYS9dojRaF56o2"}
                ]
            }
            "text-templates": {
                "data": [
                    {"type": "text-templates", "id": "KR7C7WgdvytxeTSP3dZskV"}
                ]
            },
            "page": {
                "data": null
            },
            "post": {
                "data": null
            },
            "created-by": {
                "data": {"type": "memberships", "id": "C7xWERND6yBTpJJVHACzVf"}
            },
            "updated-by": {
                "data": {"type": "memberships", "id": "C7xWERND6yBTpJJVHACzVf"}
            }
        }
    }
}

Activity Collection ¶

This resource manages the retrieval of activity collections and the creation of activity instances.

Retrieve Activities
GET`/activities{?include,filter,sort,page}`

Retrieve a collection of activities.

Example URI

GET https://api.omnigage.io/api/v1/activities?include=&filter=1&sort=created-at&page=10

URI Parameters

HideShow

include: string (optional)
Include one ore more related relationships using comma separated name.
sort: string (optional) Example: created-at
Sort on one or more fields using comma separated values.
filter: string (optional) Example: 1
Filter on one or more fields using comma separated values filter[field]=1,2.
page: string (optional) Example: 10
Use page[limit]=10 to reduce the number of instances returned. Use ?page[offset]=10 to skip this many instances.

Response 200

HideShow

Body

{
  "links": {
    "self": "/activities",
    "next": "/activities?page[offset]=10",
    "last": "/activities?page[offset]=100"
  },
  "meta": {
    "total": 110
  },
  "data": [
    {
      "id": "wpsWLdLt9nscn2jbTD3uxe",
      "type": "activities",
      "attributes": {
        "name": "Voice Blast",
        "kind": "voice",
        "retry-attempts": 0,
        "created-at": "2020-01-01T00:00:00+00:00",
        "updated-at": "2020-01-01T00:00:00+00:00"
      },
      "relationships": {
        "engagement": {
          "data": {
            "type": "engagements",
            "id": "cu8Eo9RyrUsV4MXEiDZpLM"
          }
        },
        "triggers": {
          "links": {
            "related": "/triggers?filter[activity.id]=wpsWLdLt9nscn2jbTD3uxe"
          },
          "data": []
        },
        "caller-id": {
          "data": {
            "type": "caller-ids",
            "id": "Lv8UgucPVGWcwZd9Hre9dn"
          }
        },
        "phone-number": {
          "data": null
        },
        "created-by": {
          "data": {
            "type": "memberships",
            "id": "C7xWERND6yBTpJJVHACzVf"
          }
        },
        "updated-by": {
          "data": {
            "type": "memberships",
            "id": "C7xWERND6yBTpJJVHACzVf"
          }
        }
      }
    }
  ]
}

Create Activity
POST`/activities`

Create a new activity instance.

Example URI

POST https://api.omnigage.io/api/v1/activities

Request Voice

HideShow

Schema

{
  "$schema": "http://json-schema.org/draft-04/schema#"
}

Response 201

HideShow

Body

{
  "data": {
    "id": "wpsWLdLt9nscn2jbTD3uxe",
    "type": "activities",
    "attributes": {
      "name": "Voice Blast",
      "kind": "voice",
      "retry-attempts": 0,
      "created-at": "2020-01-01T00:00:00+00:00",
      "updated-at": "2020-01-01T00:00:00+00:00"
    },
    "relationships": {
      "engagement": {
        "data": {
          "type": "engagements",
          "id": "cu8Eo9RyrUsV4MXEiDZpLM"
        }
      },
      "triggers": {
        "links": {
          "related": "/triggers?filter[activity.id]=wpsWLdLt9nscn2jbTD3uxe"
        },
        "data": []
      },
      "caller-id": {
        "data": {
          "type": "caller-ids",
          "id": "Lv8UgucPVGWcwZd9Hre9dn"
        }
      },
      "phone-number": {
        "data": null
      },
      "created-by": {
        "data": {
          "type": "memberships",
          "id": "C7xWERND6yBTpJJVHACzVf"
        }
      },
      "updated-by": {
        "data": {
          "type": "memberships",
          "id": "C7xWERND6yBTpJJVHACzVf"
        }
      }
    }
  }
}

Request Dial

HideShow

Schema

{
  "$schema": "http://json-schema.org/draft-04/schema#"
}

Response 201

HideShow

Body

{
  "data": {
    "id": "wpsWLdLt9nscn2jbTD3uxe",
    "type": "activities",
    "attributes": {
      "name": "Click-to-Dial",
      "kind": "dial",
      "created-at": "2020-01-01T00:00:00+00:00",
      "updated-at": "2020-01-01T00:00:00+00:00"
    },
    "relationships": {
      "engagement": {
        "data": {
          "type": "engagements",
          "id": "cu8Eo9RyrUsV4MXEiDZpLM"
        }
      },
      "triggers": {
        "links": {
          "related": "/triggers?filter[activity.id]=wpsWLdLt9nscn2jbTD3uxe"
        },
        "data": []
      },
      "voice-templates": {
        "data": [
          {
            "type": "voice-templates",
            "id": "GXWXjzKtTA6bEEwmsQQ6bL"
          }
        ]
      },
      "created-by": {
        "data": {
          "type": "memberships",
          "id": "C7xWERND6yBTpJJVHACzVf"
        }
      },
      "updated-by": {
        "data": {
          "type": "memberships",
          "id": "C7xWERND6yBTpJJVHACzVf"
        }
      }
    }
  }
}

Request Email

HideShow

Schema

{
  "$schema": "http://json-schema.org/draft-04/schema#"
}

Response 201

HideShow

Body

{
  "data": {
    "id": "wpsWLdLt9nscn2jbTD3uxe",
    "type": "activities",
    "attributes": {
      "name": "Email Blast",
      "kind": "email",
      "created-at": "2020-01-01T00:00:00+00:00",
      "updated-at": "2020-01-01T00:00:00+00:00"
    },
    "relationships": {
      "email-template": {
        "data": {
          "type": "email-templates",
          "id": "iDZpLM8Eo9RyrUsV4MXE"
        }
      },
      "engagement": {
        "data": {
          "type": "engagements",
          "id": "cu8Eo9RyrUsV4MXEiDZpLM"
        }
      },
      "triggers": {
        "links": {
          "related": "/triggers?filter[activity.id]=wpsWLdLt9nscn2jbTD3uxe"
        },
        "data": []
      },
      "email-id": {
        "data": {
          "type": "email-ids",
          "id": "iwXgSh6KPiF7QPd9mAorSp"
        }
      },
      "created-by": {
        "data": {
          "type": "memberships",
          "id": "C7xWERND6yBTpJJVHACzVf"
        }
      },
      "updated-by": {
        "data": {
          "type": "memberships",
          "id": "C7xWERND6yBTpJJVHACzVf"
        }
      }
    }
  }
}

Request Text

HideShow

Schema

{
  "$schema": "http://json-schema.org/draft-04/schema#"
}

Response 201

HideShow

Body

{
  "data": {
    "id": "wpsWLdLt9nscn2jbTD3uxe",
    "type": "activities",
    "attributes": {
      "name": "Text Blast",
      "kind": "text",
      "created-at": "2020-01-01T00:00:00+00:00",
      "updated-at": "2020-01-01T00:00:00+00:00"
    },
    "relationships": {
      "text-template": {
        "data": {
          "type": "text-templates",
          "id": "iDZpLM8Eo9RyrUsV4MXE"
        }
      },
      "engagement": {
        "data": {
          "type": "engagements",
          "id": "cu8Eo9RyrUsV4MXEiDZpLM"
        }
      },
      "triggers": {
        "links": {
          "related": "/triggers?filter[activity.id]=wpsWLdLt9nscn2jbTD3uxe"
        },
        "data": []
      },
      "phone-number": {
        "data": {
          "type": "phone-numbers",
          "id": "vhUWSZVAxVCCroZaXeHY9c"
        }
      },
      "created-by": {
        "data": {
          "type": "memberships",
          "id": "C7xWERND6yBTpJJVHACzVf"
        }
      },
      "updated-by": {
        "data": {
          "type": "memberships",
          "id": "C7xWERND6yBTpJJVHACzVf"
        }
      }
    }
  }
}

Activity ¶

This resource manages updating, retrieving and deleting a specified activity instance.

Retrieve Activity
GET`/activities/`

Retrieve an existing activity instance.

Example URI

GET https://api.omnigage.io/api/v1/activities/

Response 200

HideShow

Body

{
  "data": {
    "id": "wpsWLdLt9nscn2jbTD3uxe",
    "type": "activities",
    "attributes": {
      "name": "Voice Blast",
      "kind": "voice",
      "retry-attempts": 0,
      "created-at": "2020-01-01T00:00:00+00:00",
      "updated-at": "2020-01-01T00:00:00+00:00"
    },
    "relationships": {
      "engagement": {
        "data": {
          "type": "engagements",
          "id": "cu8Eo9RyrUsV4MXEiDZpLM"
        }
      },
      "transition": {
        "data": {
          "type": "triggers",
          "id": "c8sh5y9hdSMS6zVnrvf53T"
        }
      },
      "triggers": {
        "links": {
          "related": "/triggers?filter[activity.id]=wpsWLdLt9nscn2jbTD3uxe"
        },
        "data": [
          {
            "type": "triggers",
            "id": "RaF56o2r58hTKT7AYS9doj"
          },
          {
            "type": "triggers",
            "id": "vytxeTZskVKR7C7WgdSP3d"
          }
        ]
      },
      "created-by": {
        "data": {
          "type": "memberships",
          "id": "C7xWERND6yBTpJJVHACzVf"
        }
      },
      "updated-by": {
        "data": {
          "type": "memberships",
          "id": "C7xWERND6yBTpJJVHACzVf"
        }
      }
    }
  }
}

Update Activity
PATCH`/activities/`

Update an existing activity instance.

Example URI

PATCH https://api.omnigage.io/api/v1/activities/

Request

HideShow

Body

{
  "data": {
    "id": "wpsWLdLt9nscn2jbTD3uxe",
    "type": "activities",
    "attributes": {
      "name": "Voice Blast",
      "kind": "voice",
      "retry-attempts": 0,
      "created-at": "2020-01-01T00:00:00+00:00",
      "updated-at": "2020-01-01T00:00:00+00:00"
    },
    "relationships": {
      "engagement": {
        "data": {
          "type": "engagements",
          "id": "cu8Eo9RyrUsV4MXEiDZpLM"
        }
      },
      "transition": {
        "data": {
          "type": "triggers",
          "id": "c8sh5y9hdSMS6zVnrvf53T"
        }
      },
      "triggers": {
        "links": {
          "related": "/triggers?filter[activity.id]=wpsWLdLt9nscn2jbTD3uxe"
        },
        "data": [
          {
            "type": "triggers",
            "id": "RaF56o2r58hTKT7AYS9doj"
          },
          {
            "type": "triggers",
            "id": "vytxeTZskVKR7C7WgdSP3d"
          }
        ]
      },
      "created-by": {
        "data": {
          "type": "memberships",
          "id": "C7xWERND6yBTpJJVHACzVf"
        }
      },
      "updated-by": {
        "data": {
          "type": "memberships",
          "id": "C7xWERND6yBTpJJVHACzVf"
        }
      }
    }
  }
}

Response 202

HideShow

Body

{
  "data": {
    "id": "wpsWLdLt9nscn2jbTD3uxe",
    "type": "activities",
    "attributes": {
      "name": "Voice Blast",
      "kind": "voice",
      "retry-attempts": 0,
      "created-at": "2020-01-01T00:00:00+00:00",
      "updated-at": "2020-01-01T00:00:00+00:00"
    },
    "relationships": {
      "engagement": {
        "data": {
          "type": "engagements",
          "id": "cu8Eo9RyrUsV4MXEiDZpLM"
        }
      },
      "transition": {
        "data": {
          "type": "triggers",
          "id": "c8sh5y9hdSMS6zVnrvf53T"
        }
      },
      "triggers": {
        "links": {
          "related": "/triggers?filter[activity.id]=wpsWLdLt9nscn2jbTD3uxe"
        },
        "data": [
          {
            "type": "triggers",
            "id": "RaF56o2r58hTKT7AYS9doj"
          },
          {
            "type": "triggers",
            "id": "vytxeTZskVKR7C7WgdSP3d"
          }
        ]
      },
      "created-by": {
        "data": {
          "type": "memberships",
          "id": "C7xWERND6yBTpJJVHACzVf"
        }
      },
      "updated-by": {
        "data": {
          "type": "memberships",
          "id": "C7xWERND6yBTpJJVHACzVf"
        }
      }
    }
  }
}

Delete Activity
DELETE`/activities/`

Delete an existing activity instance.

Note: Cannot delete an activity that belongs to an inactive engagement.

Example URI

DELETE https://api.omnigage.io/api/v1/activities/

Response 204

Trigger Collection ¶

This resource manages the retrieval of trigger collections and the creation of trigger instances.

Rules for how triggers are processed:

A sequence of triggers are processed in the order they are defined.
Triggers that branch begin a new sequence and the previous sequence ends.
Sequences do not go backwards. If there are no further triggers to process, the sequence ends.
Triggers that terminate and branch will end if no child triggers are defined.

Name	Terminates	Branches
play	no	no
say	no	no
gather	yes	yes
prompt	no	yes
conference	yes	no
enqueue	yes	yes
notify	yes	yes
activity	no	no
hangup	yes	no
record	yes	no
pause	no	no
dial	no	no

The trigger kinds available on events:

On Event	Trigger
voice-queued	activity
voice-ringing	activity
voice-answered*	play, say, gather, prompt, conference, enqueue, notify, dial, pause, record, activity, hangup
voice-human*	play, say, gather, prompt, conference, enqueue, notify, dial, pause, record, activity, hangup
voice-machine*	play, say, activity
voice-hangup	activity
voice-unanswered	activity
voice-busy	activity
voice-failed	activity
voice-canceled	activity
voice-completed	activity
email-queued	activity
email-sent	activity
email-delivered	activity
email-open	activity
email-click	activity
email-unsubscribe	activity
email-bounce	activity
email-compliant	activity
email-failed	activity
text-queued	activity
text-sent	activity
text-delivered	activity
text-undelivered	activity
text-failed	activity

Note: On event voice-answered only supports the activity trigger for engagements with an outbound direction. On events voice-machine and voice-human only applicable for outbound engagements.

Retrieve Triggers
GET`/triggers{?include,filter,sort,page}`

Retrieve a collection of triggers.

Example URI

GET https://api.omnigage.io/api/v1/triggers?include=&filter=1&sort=created-at&page=10

URI Parameters

HideShow

include: string (optional)
Include one ore more related relationships using comma separated name.
sort: string (optional) Example: created-at
Sort on one or more fields using comma separated values.
filter: string (optional) Example: 1
Filter on one or more fields using comma separated values filter[field]=1,2.
page: string (optional) Example: 10
Use page[limit]=10 to reduce the number of instances returned. Use ?page[offset]=10 to skip this many instances.

Response 200

HideShow

Body

{
  "links": {
    "self": "/triggers",
    "next": "/triggers?page[offset]=10",
    "last": "/triggers?page[offset]=100"
  },
  "meta": {
    "total": 110
  },
  "data": [
    {
      "id": "wpsWLdLt9nscn2jbTD3uxe",
      "type": "triggers",
      "attributes": {
        "kind": "play",
        "on-event": "voice-answered",
        "loop": 1,
        "created-at": "2020-01-01T00:00:00+00:00",
        "updated-at": "2020-01-01T00:00:00+00:00"
      },
      "relationships": {
        "activity": {
          "data": {
            "type": "activities",
            "id": "cu8Eo9RyrUsV4MXEiDZpLM"
          }
        },
        "parent": {
          "data": null
        },
        "children": {
          "links": {
            "related": "/triggers?filter[parent]=wpsWLdLt9nscn2jbTD3uxe"
          },
          "data": []
        },
        "voice-template": {
          "data": {
            "type": "voice-templates",
            "id": "RyrUsV4MXEicu8Eo9DZpLM"
          }
        },
        "created-by": {
          "data": {
            "type": "memberships",
            "id": "C7xWERND6yBTpJJVHACzVf"
          }
        },
        "updated-by": {
          "data": {
            "type": "memberships",
            "id": "C7xWERND6yBTpJJVHACzVf"
          }
        }
      }
    }
  ]
}

Create Trigger
POST`/triggers`

Create a new trigger instance.

Example URI

POST https://api.omnigage.io/api/v1/triggers

Request Play Trigger

HideShow

Schema

{
  "$schema": "http://json-schema.org/draft-04/schema#"
}

Response 201

HideShow

Body

{
  "data": {
    "id": "wpsWLdLt9nscn2jbTD3uxe",
    "type": "triggers",
    "attributes": {
      "kind": "play",
      "on-event": "voice-answered",
      "loop": 1,
      "created-at": "2020-01-01T00:00:00+00:00",
      "updated-at": "2020-01-01T00:00:00+00:00"
    },
    "relationships": {
      "activity": {
        "data": {
          "type": "activities",
          "id": "cu8Eo9RyrUsV4MXEiDZpLM"
        }
      },
      "parent": {
        "data": null
      },
      "children": {
        "links": {
          "related": "/triggers?filter[parent]=wpsWLdLt9nscn2jbTD3uxe"
        },
        "data": []
      },
      "voice-template": {
        "data": {
          "type": "voice-templates",
          "id": "RyrUsV4MXEicu8Eo9DZpLM"
        }
      },
      "created-by": {
        "data": {
          "type": "memberships",
          "id": "C7xWERND6yBTpJJVHACzVf"
        }
      },
      "updated-by": {
        "data": {
          "type": "memberships",
          "id": "C7xWERND6yBTpJJVHACzVf"
        }
      }
    }
  }
}

Request Say Trigger

HideShow

Schema

{
  "$schema": "http://json-schema.org/draft-04/schema#"
}

Response 201

HideShow

Body

{
  "data": {
    "id": "wpsWLdLt9nscn2jbTD3uxe",
    "type": "triggers",
    "attributes": {
      "kind": "say",
      "on-event": "voice-answered",
      "loop": 1,
      "created-at": "2020-01-01T00:00:00+00:00",
      "updated-at": "2020-01-01T00:00:00+00:00"
    },
    "relationships": {
      "activity": {
        "data": {
          "type": "activities",
          "id": "cu8Eo9RyrUsV4MXEiDZpLM"
        }
      },
      "parent": {
        "data": null
      },
      "children": {
        "links": {
          "related": "/triggers?filter[parent]=wpsWLdLt9nscn2jbTD3uxe"
        },
        "data": []
      },
      "voice-template": {
        "data": {
          "type": "voice-templates",
          "id": "RyrUsV4MXEicu8Eo9DZpLM"
        }
      },
      "created-by": {
        "data": {
          "type": "memberships",
          "id": "C7xWERND6yBTpJJVHACzVf"
        }
      },
      "updated-by": {
        "data": {
          "type": "memberships",
          "id": "C7xWERND6yBTpJJVHACzVf"
        }
      }
    }
  }
}

Request Gather Trigger

HideShow

Schema

{
  "$schema": "http://json-schema.org/draft-04/schema#"
}

Response 201

HideShow

Body

{
  "data": {
    "id": "wpsWLdLt9nscn2jbTD3uxe",
    "type": "triggers",
    "attributes": {
      "kind": "gather",
      "on-event": "voice-answered",
      "input": [
        "dtmf"
      ],
      "timeout": 5,
      "dtmf-digit-count": 1,
      "dtmf-digit-stop": "#",
      "created-at": "2020-01-01T00:00:00+00:00",
      "updated-at": "2020-01-01T00:00:00+00:00"
    },
    "relationships": {
      "activity": {
        "data": {
          "type": "activities",
          "id": "cu8Eo9RyrUsV4MXEiDZpLM"
        }
      },
      "parent": {
        "data": null
      },
      "children": {
        "links": {
          "related": "/triggers?filter[parent]=wpsWLdLt9nscn2jbTD3uxe"
        },
        "data": []
      },
      "created-by": {
        "data": {
          "type": "memberships",
          "id": "C7xWERND6yBTpJJVHACzVf"
        }
      },
      "updated-by": {
        "data": {
          "type": "memberships",
          "id": "C7xWERND6yBTpJJVHACzVf"
        }
      }
    }
  }
}

Request Prompt Trigger

HideShow

Schema

{
  "$schema": "http://json-schema.org/draft-04/schema#"
}

Response 201

HideShow

Body

{
  "data": {
    "id": "wpsWLdLt9nscn2jbTD3uxe",
    "type": "triggers",
    "attributes": {
      "kind": "prompt",
      "on-event": "voice-answered",
      "digits": "1",
      "speech": "yes",
      "created-at": "2020-01-01T00:00:00+00:00",
      "updated-at": "2020-01-01T00:00:00+00:00"
    },
    "relationships": {
      "activity": {
        "data": {
          "type": "activities",
          "id": "cu8Eo9RyrUsV4MXEiDZpLM"
        }
      },
      "parent": {
        "data": null
      },
      "children": {
        "links": {
          "related": "/triggers?filter[parent]=wpsWLdLt9nscn2jbTD3uxe"
        },
        "data": []
      },
      "created-by": {
        "data": {
          "type": "memberships",
          "id": "C7xWERND6yBTpJJVHACzVf"
        }
      },
      "updated-by": {
        "data": {
          "type": "memberships",
          "id": "C7xWERND6yBTpJJVHACzVf"
        }
      }
    }
  }
}

Request Conference Trigger

HideShow

Schema

{
  "$schema": "http://json-schema.org/draft-04/schema#"
}

Response 201

HideShow

Body

{
  "data": {
    "id": "wpsWLdLt9nscn2jbTD3uxe",
    "type": "triggers",
    "attributes": {
      "kind": "conference",
      "on-event": "voice-answered",
      "created-at": "2020-01-01T00:00:00+00:00",
      "updated-at": "2020-01-01T00:00:00+00:00"
    },
    "relationships": {
      "activity": {
        "data": {
          "type": "activities",
          "id": "cu8Eo9RyrUsV4MXEiDZpLM"
        }
      },
      "parent": {
        "data": null
      },
      "children": {
        "links": {
          "related": "/triggers?filter[parent]=wpsWLdLt9nscn2jbTD3uxe"
        },
        "data": []
      },
      "conference": {
        "data": {
          "type": "conferences",
          "id": "ofmQYL5c7GmxcnmpeXybaF"
        }
      },
      "created-by": {
        "data": {
          "type": "memberships",
          "id": "C7xWERND6yBTpJJVHACzVf"
        }
      },
      "updated-by": {
        "data": {
          "type": "memberships",
          "id": "C7xWERND6yBTpJJVHACzVf"
        }
      }
    }
  }
}

Request Enqueue Trigger

HideShow

Schema

{
  "$schema": "http://json-schema.org/draft-04/schema#"
}

Response 201

HideShow

Body

{
  "data": {
    "id": "wpsWLdLt9nscn2jbTD3uxe",
    "type": "triggers",
    "attributes": {
      "kind": "enqueue",
      "on-event": "voice-answered",
      "created-at": "2020-01-01T00:00:00+00:00",
      "updated-at": "2020-01-01T00:00:00+00:00"
    },
    "relationships": {
      "activity": {
        "data": {
          "type": "activities",
          "id": "cu8Eo9RyrUsV4MXEiDZpLM"
        }
      },
      "parent": {
        "data": null
      },
      "children": {
        "links": {
          "related": "/triggers?filter[parent]=wpsWLdLt9nscn2jbTD3uxe"
        },
        "data": []
      },
      "created-by": {
        "data": {
          "type": "memberships",
          "id": "C7xWERND6yBTpJJVHACzVf"
        }
      },
      "updated-by": {
        "data": {
          "type": "memberships",
          "id": "C7xWERND6yBTpJJVHACzVf"
        }
      }
    }
  }
}

Request Notify Trigger

HideShow

Schema

{
  "$schema": "http://json-schema.org/draft-04/schema#"
}

Response 201

HideShow

Body

{
  "data": {
    "id": "wpsWLdLt9nscn2jbTD3uxe",
    "type": "triggers",
    "attributes": {
      "kind": "notify",
      "on-event": "voice-answered",
      "created-at": "2020-01-01T00:00:00+00:00",
      "updated-at": "2020-01-01T00:00:00+00:00"
    },
    "relationships": {
      "activity": {
        "data": {
          "type": "activities",
          "id": "cu8Eo9RyrUsV4MXEiDZpLM"
        }
      },
      "parent": {
        "data": null
      },
      "children": {
        "links": {
          "related": "/triggers?filter[parent]=wpsWLdLt9nscn2jbTD3uxe"
        },
        "data": []
      },
      "created-by": {
        "data": {
          "type": "memberships",
          "id": "C7xWERND6yBTpJJVHACzVf"
        }
      },
      "updated-by": {
        "data": {
          "type": "memberships",
          "id": "C7xWERND6yBTpJJVHACzVf"
        }
      }
    }
  }
}

Request Dial Trigger

HideShow

Schema

{
  "$schema": "http://json-schema.org/draft-04/schema#"
}

Response 201

HideShow

Body

{
  "data": {
    "id": "wpsWLdLt9nscn2jbTD3uxe",
    "type": "triggers",
    "attributes": {
      "kind": "dial",
      "on-event": "voice-answered",
      "phone-number": "+15197566220",
      "created-at": "2020-01-01T00:00:00+00:00",
      "updated-at": "2020-01-01T00:00:00+00:00"
    },
    "relationships": {
      "activity": {
        "data": {
          "type": "activities",
          "id": "cu8Eo9RyrUsV4MXEiDZpLM"
        }
      },
      "parent": {
        "data": null
      },
      "children": {
        "links": {
          "related": "/triggers?filter[parent]=wpsWLdLt9nscn2jbTD3uxe"
        },
        "data": []
      },
      "created-by": {
        "data": {
          "type": "memberships",
          "id": "C7xWERND6yBTpJJVHACzVf"
        }
      },
      "updated-by": {
        "data": {
          "type": "memberships",
          "id": "C7xWERND6yBTpJJVHACzVf"
        }
      }
    }
  }
}

Request Pause Trigger

HideShow

Schema

{
  "$schema": "http://json-schema.org/draft-04/schema#"
}

Response 201

HideShow

Body

{
  "data": {
    "id": "wpsWLdLt9nscn2jbTD3uxe",
    "type": "triggers",
    "attributes": {
      "kind": "pause",
      "on-event": "voice-answered",
      "length": 5,
      "created-at": "2020-01-01T00:00:00+00:00",
      "updated-at": "2020-01-01T00:00:00+00:00"
    },
    "relationships": {
      "activity": {
        "data": {
          "type": "activities",
          "id": "cu8Eo9RyrUsV4MXEiDZpLM"
        }
      },
      "parent": {
        "data": null
      },
      "children": {
        "links": {
          "related": "/triggers?filter[parent]=wpsWLdLt9nscn2jbTD3uxe"
        },
        "data": []
      },
      "created-by": {
        "data": {
          "type": "memberships",
          "id": "C7xWERND6yBTpJJVHACzVf"
        }
      },
      "updated-by": {
        "data": {
          "type": "memberships",
          "id": "C7xWERND6yBTpJJVHACzVf"
        }
      }
    }
  }
}

Request Record Trigger

HideShow

Schema

{
  "$schema": "http://json-schema.org/draft-04/schema#"
}

Response 201

HideShow

Body

{
  "data": {
    "id": "wpsWLdLt9nscn2jbTD3uxe",
    "type": "triggers",
    "attributes": {
      "kind": "record",
      "on-event": "voice-answered",
      "length": 600,
      "timeout": 5,
      "trim": true,
      "transcribe": false,
      "beep": true,
      "digit-stop": "#",
      "created-at": "2020-01-01T00:00:00+00:00",
      "updated-at": "2020-01-01T00:00:00+00:00"
    },
    "relationships": {
      "activity": {
        "data": {
          "type": "activities",
          "id": "cu8Eo9RyrUsV4MXEiDZpLM"
        }
      },
      "parent": {
        "data": null
      },
      "children": {
        "links": {
          "related": "/triggers?filter[parent]=wpsWLdLt9nscn2jbTD3uxe"
        },
        "data": []
      },
      "created-by": {
        "data": {
          "type": "memberships",
          "id": "C7xWERND6yBTpJJVHACzVf"
        }
      },
      "updated-by": {
        "data": {
          "type": "memberships",
          "id": "C7xWERND6yBTpJJVHACzVf"
        }
      }
    }
  }
}

Request Activity Trigger

HideShow

Schema

{
  "$schema": "http://json-schema.org/draft-04/schema#"
}

Response 201

HideShow

Body

{
    "data": {
        "id": "wpsWLdLt9nscn2jbTD3uxe",
        "type": "triggers",
        "attributes": {
            "kind": "activity",
            "on-event": "voice-answered",
            "created-at": "2020-01-01T00:00:00+00:00",
            "updated-at": "2020-01-01T00:00:00+00:00"
            "delay-in-seconds": 3600,
        },
        "relationships": {
            "activity": {
                "data": {"type": "activities", "id": "cu8Eo9RyrUsV4MXEiDZpLM"}
            },
            "parent": {
                "data": null
            },
            "children": {
                "links": {
                    "related": "/triggers?filter[parent]=wpsWLdLt9nscn2jbTD3uxe"
                },
                "data": []
            },
            "transition": {
                "data": null
            },
            "created-by": {
                "data": {"type": "memberships", "id": "C7xWERND6yBTpJJVHACzVf"}
            },
            "updated-by": {
                "data": {"type": "memberships", "id": "C7xWERND6yBTpJJVHACzVf"}
            }
        }
    }
}

Request Hangup Trigger

HideShow

Schema

{
  "$schema": "http://json-schema.org/draft-04/schema#"
}

Response 201

HideShow

Body

{
  "data": {
    "id": "wpsWLdLt9nscn2jbTD3uxe",
    "type": "triggers",
    "attributes": {
      "kind": "hangup",
      "on-event": "voice-answered",
      "created-at": "2020-01-01T00:00:00+00:00",
      "updated-at": "2020-01-01T00:00:00+00:00"
    },
    "relationships": {
      "activity": {
        "data": {
          "type": "activities",
          "id": "cu8Eo9RyrUsV4MXEiDZpLM"
        }
      },
      "parent": {
        "data": null
      },
      "children": {
        "links": {
          "related": "/triggers?filter[parent]=wpsWLdLt9nscn2jbTD3uxe"
        },
        "data": []
      },
      "created-by": {
        "data": {
          "type": "memberships",
          "id": "C7xWERND6yBTpJJVHACzVf"
        }
      },
      "updated-by": {
        "data": {
          "type": "memberships",
          "id": "C7xWERND6yBTpJJVHACzVf"
        }
      }
    }
  }
}

Trigger ¶

This resource manages updating, retrieving and deleting a specified trigger instance.

Retrieve Trigger
GET`/triggers/`

Retrieve an existing trigger instance.

Example URI

GET https://api.omnigage.io/api/v1/triggers/

Response 200

HideShow

Body

{
  "data": {
    "id": "wpsWLdLt9nscn2jbTD3uxe",
    "type": "triggers",
    "attributes": {
      "kind": "play",
      "on-event": "voice-answered",
      "loop": 1,
      "created-at": "2020-01-01T00:00:00+00:00",
      "updated-at": "2020-01-01T00:00:00+00:00"
    },
    "relationships": {
      "activity": {
        "data": {
          "type": "activities",
          "id": "cu8Eo9RyrUsV4MXEiDZpLM"
        }
      },
      "parent": {
        "data": null
      },
      "children": {
        "links": {
          "related": "/triggers?filter[parent]=wpsWLdLt9nscn2jbTD3uxe"
        },
        "data": []
      },
      "voice-template": {
        "data": {
          "type": "voice-templates",
          "id": "RyrUsV4MXEicu8Eo9DZpLM"
        }
      },
      "created-by": {
        "data": {
          "type": "memberships",
          "id": "C7xWERND6yBTpJJVHACzVf"
        }
      },
      "updated-by": {
        "data": {
          "type": "memberships",
          "id": "C7xWERND6yBTpJJVHACzVf"
        }
      }
    }
  }
}

Update Trigger
PATCH`/triggers/`

Update an existing trigger instance.

Example URI

PATCH https://api.omnigage.io/api/v1/triggers/

Request

HideShow

Body

{
  "data": {
    "id": "wpsWLdLt9nscn2jbTD3uxe",
    "type": "triggers",
    "attributes": {
      "kind": "play",
      "on-event": "voice-answered",
      "loop": 1,
      "created-at": "2020-01-01T00:00:00+00:00",
      "updated-at": "2020-01-01T00:00:00+00:00"
    },
    "relationships": {
      "activity": {
        "data": {
          "type": "activities",
          "id": "cu8Eo9RyrUsV4MXEiDZpLM"
        }
      },
      "parent": {
        "data": null
      },
      "children": {
        "links": {
          "related": "/triggers?filter[parent]=wpsWLdLt9nscn2jbTD3uxe"
        },
        "data": []
      },
      "voice-template": {
        "data": {
          "type": "voice-templates",
          "id": "RyrUsV4MXEicu8Eo9DZpLM"
        }
      },
      "created-by": {
        "data": {
          "type": "memberships",
          "id": "C7xWERND6yBTpJJVHACzVf"
        }
      },
      "updated-by": {
        "data": {
          "type": "memberships",
          "id": "C7xWERND6yBTpJJVHACzVf"
        }
      }
    }
  }
}

Response 202

HideShow

Body

{
  "data": {
    "id": "wpsWLdLt9nscn2jbTD3uxe",
    "type": "triggers",
    "attributes": {
      "kind": "play",
      "on-event": "voice-answered",
      "loop": 1,
      "created-at": "2020-01-01T00:00:00+00:00",
      "updated-at": "2020-01-01T00:00:00+00:00"
    },
    "relationships": {
      "activity": {
        "data": {
          "type": "activities",
          "id": "cu8Eo9RyrUsV4MXEiDZpLM"
        }
      },
      "parent": {
        "data": null
      },
      "children": {
        "links": {
          "related": "/triggers?filter[parent]=wpsWLdLt9nscn2jbTD3uxe"
        },
        "data": []
      },
      "voice-template": {
        "data": {
          "type": "voice-templates",
          "id": "RyrUsV4MXEicu8Eo9DZpLM"
        }
      },
      "created-by": {
        "data": {
          "type": "memberships",
          "id": "C7xWERND6yBTpJJVHACzVf"
        }
      },
      "updated-by": {
        "data": {
          "type": "memberships",
          "id": "C7xWERND6yBTpJJVHACzVf"
        }
      }
    }
  }
}

Delete Trigger
DELETE`/triggers/`

Delete an existing trigger instance.

Note: Cannot delete an trigger that belongs to an inactive engagement.

Example URI

DELETE https://api.omnigage.io/api/v1/triggers/

Response 204

Envelope Collection ¶

This resource manages the collection retrieval and creation of envelope instances.

Note: By default, instances are limited based on collaborator access to a given engagement. Additionally, instances can be limited based on collaborator access to a given contact. Envelopes base visibility is determined by either the engagement or the contact with any additional filters then being applied.

Retrieve Envelopes
GET`/envelopes{?include,filter,sort,page}`

Retrieve a collection of envelopes.

Example URI

GET https://api.omnigage.io/api/v1/envelopes?include=&filter=1&sort=created-at&page=10

URI Parameters

HideShow

include: string (optional)
Include one ore more related relationships using comma separated name.
sort: string (optional) Example: created-at
Sort on one or more fields using comma separated values.
filter: string (optional) Example: 1
Filter on one or more fields using comma separated values filter[field]=1,2.
page: string (optional) Example: 10
Use page[limit]=10 to reduce the number of instances returned. Use ?page[offset]=10 to skip this many instances.

Response 200

HideShow

Body

{
    "links": {
        "self": "/envelopes",
        "next": "/envelopes?page[offset]=10",
        "last": "/envelopes?page[offset]=100"
    },
    "meta": {
        "total": 110
    },
    "data": [{
        "id": "c8sh5y9hdSMS6zVnrvf53T",
        "type": "envelopes",
        "attributes": {
            "status": "complete",
            "kind": "voice",
            "direction": "outbound",
            "phone-number": "+15197566220",
            "email-address": null,
            "retry-attempts": null,
            "callback": null,
            "meta": {},
            "delay-in-seconds": 0,
            "scheduled-at": null,
            "processed-at": null,
            "completed-at": null,
            "created-at": "2020-01-01T00:00:00+00:00",
            "updated-at": "2020-01-01T00:00:00+00:00",
        },
        "relationships": {
            "engagement": {
                "data": {"type": "engagements", "id": "yrbCdxqV2ZMdQBCszhA7TZ"}
            },
            "activity": {
                "data": {"type": "activities", "id": "NqYmqDA26JmTJz6SnCWt3v"}
            },
            "contact": {
                "data": {"type": "contacts", "id": "z8eDV4PCWqGAn7H3BF6jkV"}
            },
            "identity": {
                "data": {"type": "users", "id": "9gmvjZgfkTPwiMfps3e4Tg"}
            },
            "call": {
                "data": {"type": "calls", "id": "fAuHnD4CMpJvmhkzrjw8mr"}
            },
            "email": {
                "data": null
            },
            "text": {
                "data": null
            },
            "created-by": {
                "data": {"type": "memberships", "id": "C7xWERND6yBTpJJVHACzVf"}
            },
            "updated-by": {
                "data": {"type": "memberships", "id": "C7xWERND6yBTpJJVHACzVf"}
            }
        }
    }]
}

Create Envelope
POST`/envelopes`

Create a new envelope instance.

Example URI

POST https://api.omnigage.io/api/v1/envelopes

Request Envelope with Contact

HideShow

Body

{
  "data": {
    "type": "envelopes",
    "relationships": {
      "engagement": {
        "data": {
          "type": "engagements",
          "id": "yrbCdxqV2ZMdQBCszhA7TZ"
        }
      },
      "contact": {
        "data": {
          "type": "contacts",
          "id": "z8eDV4PCWqGAn7H3BF6jkV"
        }
      }
    }
  }
}

Response 201

HideShow

Body

{
  "data": {
    "id": "c8sh5y9hdSMS6zVnrvf53T",
    "type": "envelopes",
    "attributes": {
      "status": "pending",
      "kind": "dial",
      "direction": "outbound",
      "phone-number": null,
      "email-address": null,
      "retry-attempts": null,
      "meta": {},
      "delay-in-seconds": 0,
      "scheduled-at": null,
      "processed-at": null,
      "completed-at": null,
      "created-at": "2020-01-01T00:00:00+00:00",
      "updated-at": "2020-01-01T00:00:00+00:00"
    },
    "relationships": {
      "engagement": {
        "data": {
          "type": "engagements",
          "id": "yrbCdxqV2ZMdQBCszhA7TZ"
        }
      },
      "activity": {
        "data": {
          "type": "activities",
          "id": "NqYmqDA26JmTJz6SnCWt3v"
        }
      },
      "contact": {
        "data": {
          "type": "contacts",
          "id": "z8eDV4PCWqGAn7H3BF6jkV"
        }
      },
      "identity": {
        "data": {
          "type": "users",
          "id": "9gmvjZgfkTPwiMfps3e4Tg"
        }
      },
      "call": {
        "data": {
          "type": "calls",
          "id": "fAuHnD4CMpJvmhkzrjw8mr"
        }
      },
      "email": {
        "data": null
      },
      "text": {
        "data": null
      },
      "created-by": {
        "data": {
          "type": "memberships",
          "id": "C7xWERND6yBTpJJVHACzVf"
        }
      },
      "updated-by": {
        "data": {
          "type": "memberships",
          "id": "C7xWERND6yBTpJJVHACzVf"
        }
      }
    }
  }
}

Request Envelope with Meta

HideShow

Body

{
  "data": {
    "type": "envelopes",
    "attributes": {
      "phone-number": "+15197566220",
      "email-address": "alexander.bell@bell-labs.com",
      "meta": {
        "first-name": "Alexander",
        "last-name": "Bell"
      }
    },
    "relationships": {
      "engagement": {
        "data": {
          "type": "engagements",
          "id": "yrbCdxqV2ZMdQBCszhA7TZ"
        }
      }
    }
  }
}

Response 201

HideShow

Body

{
  "data": {
    "id": "c8sh5y9hdSMS6zVnrvf53T",
    "type": "envelopes",
    "attributes": {
      "status": "pending",
      "kind": "voice",
      "phone-number": "+15197566220",
      "email-address": "alexander.bell@bell-labs.com",
      "direction": "outbound",
      "retry-attempts": null,
      "callback": null,
      "meta": {
        "first-name": "Alexander",
        "last-name": "Bell"
      },
      "delay-in-seconds": 0,
      "scheduled-at": null,
      "processed-at": null,
      "completed-at": null,
      "created-at": "2020-01-01T00:00:00+00:00",
      "updated-at": "2020-01-01T00:00:00+00:00"
    },
    "relationships": {
      "engagement": {
        "data": {
          "type": "engagements",
          "id": "yrbCdxqV2ZMdQBCszhA7TZ"
        }
      },
      "activity": {
        "data": {
          "type": "activities",
          "id": "NqYmqDA26JmTJz6SnCWt3v"
        }
      },
      "contact": {
        "data": null
      },
      "identity": {
        "data": null
      },
      "call": {
        "data": null
      },
      "email": {
        "data": null
      },
      "text": {
        "data": null
      },
      "created-by": {
        "data": {
          "type": "memberships",
          "id": "C7xWERND6yBTpJJVHACzVf"
        }
      },
      "updated-by": {
        "data": {
          "type": "memberships",
          "id": "C7xWERND6yBTpJJVHACzVf"
        }
      }
    }
  }
}

Request

HideShow

Headers

Content-Type: application/vnd.api+json; ext=bulk

Body

{
  "data": [
    {
      "type": "envelopes",
      "relationships": {
        "engagement": {
          "data": {
            "type": "engagements",
            "id": "yrbCdxqV2ZMdQBCszhA7TZ"
          }
        },
        "contact": {
          "data": {
            "type": "contacts",
            "id": "r58hTKT7AYS9dojRaF56o2"
          }
        }
      }
    },
    {
      "type": "envelopes",
      "relationships": {
        "engagement": {
          "data": {
            "type": "engagements",
            "id": "yrbCdxqV2ZMdQBCszhA7TZ"
          }
        },
        "contact": {
          "data": {
            "type": "contacts",
            "id": "NhcgbRnHhByzFEJBaVojx3"
          }
        }
      }
    }
  ]
}

Response 201

HideShow

Body

{
  "data": [
    {
      "id": "c8sh5y9hdSMS6zVnrvf53T",
      "type": "envelopes",
      "attributes": {
        "status": "pending",
        "kind": "voice",
        "phone-number": null,
        "email-address": null,
        "direction": "outbound",
        "retry-attempts": null,
        "meta": {},
        "scheduled-at": null,
        "processed-at": null,
        "completed-at": null,
        "created-at": "2020-01-01T00:00:00+00:00",
        "updated-at": "2020-01-01T00:00:00+00:00"
      },
      "relationships": {
        "engagement": {
          "data": {
            "type": "engagements",
            "id": "yrbCdxqV2ZMdQBCszhA7TZ"
          }
        },
        "activity": {
          "data": {
            "type": "activities",
            "id": "NqYmqDA26JmTJz6SnCWt3v"
          }
        },
        "contact": {
          "data": {
            "type": "contacts",
            "id": "r58hTKT7AYS9dojRaF56o2"
          }
        },
        "identity": {
          "data": {
            "type": "users",
            "id": "9gmvjZgfkTPwiMfps3e4Tg"
          }
        },
        "call": {
          "data": null
        },
        "email": {
          "data": null
        },
        "text": {
          "data": null
        },
        "created-by": {
          "data": {
            "type": "memberships",
            "id": "C7xWERND6yBTpJJVHACzVf"
          }
        },
        "updated-by": {
          "data": {
            "type": "memberships",
            "id": "C7xWERND6yBTpJJVHACzVf"
          }
        }
      }
    },
    {
      "id": "c8sh5y9hdSMS6zVnrvf53T",
      "type": "envelopes",
      "attributes": {
        "status": "pending",
        "kind": "voice",
        "phone-number": null,
        "email-address": null,
        "direction": "outbound",
        "retry-attempts": null,
        "meta": {},
        "delay-in-seconds": 0,
        "scheduled-at": null,
        "processed-at": null,
        "completed-at": null,
        "created-at": "2020-01-01T00:00:00+00:00",
        "updated-at": "2020-01-01T00:00:00+00:00"
      },
      "relationships": {
        "engagement": {
          "data": {
            "type": "engagements",
            "id": "yrbCdxqV2ZMdQBCszhA7TZ"
          }
        },
        "activity": {
          "data": {
            "type": "activities",
            "id": "4XKsvi55Q3SngvjEdjmvYu"
          }
        },
        "contact": {
          "data": {
            "type": "contacts",
            "id": "NhcgbRnHhByzFEJBaVojx3"
          }
        },
        "identity": {
          "data": {
            "type": "users",
            "id": "9gmvjZgfkTPwiMfps3e4Tg"
          }
        },
        "call": {
          "data": null
        },
        "email": {
          "data": null
        },
        "text": {
          "data": null
        },
        "created-by": {
          "data": {
            "type": "memberships",
            "id": "C7xWERND6yBTpJJVHACzVf"
          }
        },
        "updated-by": {
          "data": {
            "type": "memberships",
            "id": "C7xWERND6yBTpJJVHACzVf"
          }
        }
      }
    }
  ]
}

Envelope ¶

This resource manages retrieving a specified envelope instance.

Retrieve Envelope
GET`/envelopes/`

Retrieve an existing envelope instance.

Example URI

GET https://api.omnigage.io/api/v1/envelopes/

Response 200

HideShow

Body

{
  "data": {
    "id": "c8sh5y9hdSMS6zVnrvf53T",
    "type": "envelopes",
    "attributes": {
      "status": "complete",
      "kind": "voice",
      "direction": "outbound",
      "phone-number": "+15197566220",
      "email-address": null,
      "retry-attempts": null,
      "callback": null,
      "meta": {},
      "delay-in-seconds": 0,
      "scheduled-at": null,
      "processed-at": null,
      "completed-at": null,
      "created-at": "2020-01-01T00:00:00+00:00",
      "updated-at": "2020-01-01T00:00:00+00:00"
    },
    "relationships": {
      "engagement": {
        "data": {
          "type": "engagements",
          "id": "yrbCdxqV2ZMdQBCszhA7TZ"
        }
      },
      "activity": {
        "data": {
          "type": "activities",
          "id": "NqYmqDA26JmTJz6SnCWt3v"
        }
      },
      "contact": {
        "data": {
          "type": "contacts",
          "id": "z8eDV4PCWqGAn7H3BF6jkV"
        }
      },
      "identity": {
        "data": {
          "type": "users",
          "id": "9gmvjZgfkTPwiMfps3e4Tg"
        }
      },
      "call": {
        "data": {
          "type": "calls",
          "id": "fAuHnD4CMpJvmhkzrjw8mr"
        }
      },
      "email": {
        "data": null
      },
      "text": {
        "data": null
      },
      "created-by": {
        "data": {
          "type": "memberships",
          "id": "C7xWERND6yBTpJJVHACzVf"
        }
      },
      "updated-by": {
        "data": {
          "type": "memberships",
          "id": "C7xWERND6yBTpJJVHACzVf"
        }
      }
    }
  }
}

Call Resources ¶

Call Collection ¶

This resource provides querying of the calls collection along with the creation of call instances.

Note: Only instances relating to a caller-id or phone-number the membership has collaborator access to will be returned. Instances that do not carry a caller-id and phone-number will be returned to the creator.

Retrieve Call
GET`/calls{?include,filter,sort,page}`

Retrieve a collection of calls.

Example URI

GET https://api.omnigage.io/api/v1/calls?include=&filter=1&sort=created-at&page=10

URI Parameters

HideShow

include: string (optional)
Include one ore more related relationships using comma separated name.
sort: string (optional) Example: created-at
Sort on one or more fields using comma separated values.
filter: string (optional) Example: 1
Filter on one or more fields using comma separated values filter[field]=1,2.
page: string (optional) Example: 10
Use page[limit]=10 to reduce the number of instances returned. Use ?page[offset]=10 to skip this many instances.

Response 200

HideShow

Body

{
  "links": {
    "self": "/calls",
    "next": "/calls?page[offset]=10",
    "last": "/calls?page[offset]=100"
  },
  "meta": {
    "total": 10
  },
  "data": [
    {
      "id": "BojTqHDXSK7KcLCn5cZcc8",
      "type": "calls",
      "attributes": {
        "from": "+18775550100",
        "to": "+15197566220",
        "status": "in-progress",
        "direction": "outbound",
        "duration": 67,
        "kind": "native",
        "callback": null,
        "meta": {},
        "started-at": "2020-01-01T00:00:00+00:00",
        "finished-at": null,
        "created-at": "2020-01-01T00:00:00+00:00",
        "updated-at": "2020-01-01T00:00:00+00:00"
      },
      "relationships": {
        "parent-call": {
          "data": {
            "type": "calls",
            "id": "KXq9WyvGHx8ueyWLooLkMP"
          }
        },
        "caller-id": {
          "data": {
            "type": "caller-ids",
            "id": "DECRngt4uXqsvCgbyM7d7p"
          }
        },
        "phone-number": {
          "data": null
        },
        "envelope": {
          "data": {
            "type": "envelopes",
            "id": "uLjLNq6tkPEhTuCUQsuipq"
          }
        },
        "contact": {
          "data": {
            "type": "contacts",
            "id": "KVLK7zmqDZxCtVYAb4mAqR"
          }
        },
        "voice-template": {
          "data": null
        },
        "memberships": {
          "data": []
        },
        "conference": {
          "data": null
        },
        "result": {
          "data": {
            "type": "call-results",
            "id": "SYv626tNVtprEQmMJDdr6B"
          }
        },
        "results": {
          "links": {
            "related": "/call-results?filter[call.id]=BojTqHDXSK7KcLCn5cZcc8"
          }
        },
        "recordings": {
          "links": {
            "related": "/recordings?filter[call.id]=BojTqHDXSK7KcLCn5cZcc8"
          }
        },
        "created-by": {
          "data": {
            "type": "memberships",
            "id": "C7xWERND6yBTpJJVHACzVf"
          }
        },
        "updated-by": {
          "data": {
            "type": "memberships",
            "id": "C7xWERND6yBTpJJVHACzVf"
          }
        }
      }
    }
  ]
}

Create Call
POST`/calls`

Create a new calls instance.

Example URI

POST https://api.omnigage.io/api/v1/calls

Request Parent Call

HideShow

Body

{
  "data": {
    "type": "calls",
    "attributes": {
      "to": "+15197566220",
      "action": "dial"
    }
  }
}

Response 201

HideShow

Body

{
  "data": {
    "id": "BojTqHDXSK7KcLCn5cZcc8",
    "type": "calls",
    "attributes": {
      "from": null,
      "to": "+15197566220",
      "status": "in-progress",
      "direction": "outbound",
      "duration": 1,
      "kind": "native",
      "callback": null,
      "meta": {},
      "started-at": "2020-01-01T00:00:00+00:00",
      "finished-at": null,
      "created-at": "2020-01-01T00:00:00+00:00",
      "updated-at": "2020-01-01T00:00:00+00:00"
    },
    "relationships": {
      "parent-call": {
        "data": null
      },
      "caller-id": {
        "data": null
      },
      "phone-number": {
        "data": null
      },
      "envelope": {
        "data": null
      },
      "contact": {
        "data": null
      },
      "voice-template": {
        "data": null
      },
      "memberships": {
        "data": []
      },
      "conference": {
        "data": null
      },
      "result": {
        "data": {
          "type": "call-results",
          "id": "SYv626tNVtprEQmMJDdr6B"
        }
      },
      "results": {
        "links": {
          "related": "/call-results?filter[call.id]=BojTqHDXSK7KcLCn5cZcc8"
        }
      },
      "recordings": {
        "links": {
          "related": "/recordings?filter[call.id]=BojTqHDXSK7KcLCn5cZcc8"
        }
      },
      "created-by": {
        "data": {
          "type": "memberships",
          "id": "C7xWERND6yBTpJJVHACzVf"
        }
      },
      "updated-by": {
        "data": {
          "type": "memberships",
          "id": "C7xWERND6yBTpJJVHACzVf"
        }
      }
    }
  }
}

Request Child Call

HideShow

Body

{
  "data": {
    "type": "calls",
    "attributes": {
      "to": "+15197566220",
      "action": "dial"
    },
    "relationships": {
      "parent-call": {
        "data": {
          "type": "calls",
          "id": "KXq9WyvGHx8ueyWLooLkMP"
        }
      },
      "caller-id": {
        "data": {
          "type": "caller-ids",
          "id": "DECRngt4uXqsvCgbyM7d7p"
        }
      },
      "contact": {
        "data": {
          "type": "contacts",
          "id": "KVLK7zmqDZxCtVYAb4mAqR"
        }
      }
    }
  }
}

Response 201

HideShow

Body

{
  "data": {
    "id": "BojTqHDXSK7KcLCn5cZcc8",
    "type": "calls",
    "attributes": {
      "from": "+18775550100",
      "to": "+15197566220",
      "status": "in-progress",
      "direction": "outbound",
      "duration": 1,
      "kind": "native",
      "callback": null,
      "meta": {},
      "started-at": "2020-01-01T00:00:00+00:00",
      "finished-at": null,
      "created-at": "2020-01-01T00:00:00+00:00",
      "updated-at": "2020-01-01T00:00:00+00:00"
    },
    "relationships": {
      "parent-call": {
        "data": {
          "type": "calls",
          "id": "KXq9WyvGHx8ueyWLooLkMP"
        }
      },
      "caller-id": {
        "data": {
          "type": "caller-ids",
          "id": "DECRngt4uXqsvCgbyM7d7p"
        }
      },
      "phone-number": {
        "data": null
      },
      "envelope": {
        "data": {
          "type": "envelopes",
          "id": "uLjLNq6tkPEhTuCUQsuipq"
        }
      },
      "contact": {
        "data": {
          "type": "contacts",
          "id": "KVLK7zmqDZxCtVYAb4mAqR"
        }
      },
      "voice-template": {
        "data": null
      },
      "memberships": {
        "data": []
      },
      "conference": {
        "data": null
      },
      "result": {
        "data": {
          "type": "call-results",
          "id": "SYv626tNVtprEQmMJDdr6B"
        }
      },
      "results": {
        "links": {
          "related": "/call-results?filter[call.id]=BojTqHDXSK7KcLCn5cZcc8"
        }
      },
      "recordings": {
        "links": {
          "related": "/recordings?filter[call.id]=BojTqHDXSK7KcLCn5cZcc8"
        }
      },
      "created-by": {
        "data": {
          "type": "memberships",
          "id": "C7xWERND6yBTpJJVHACzVf"
        }
      },
      "updated-by": {
        "data": {
          "type": "memberships",
          "id": "C7xWERND6yBTpJJVHACzVf"
        }
      }
    }
  }
}

Request Combined Parent and Child Call

HideShow

Body

{
  "data": {
    "type": "calls",
    "attributes": {
      "from": "+18775550100",
      "to": "+15197566220",
      "action": "dial"
    },
    "relationships": {
      "caller-id": {
        "data": {
          "type": "caller-ids",
          "id": "DECRngt4uXqsvCgbyM7d7p"
        }
      },
      "contact": {
        "data": {
          "type": "contacts",
          "id": "KVLK7zmqDZxCtVYAb4mAqR"
        }
      }
    }
  }
}

Response 201

HideShow

Body

{
  "data": {
    "id": "BojTqHDXSK7KcLCn5cZcc8",
    "type": "calls",
    "attributes": {
      "from": "+18775550100",
      "to": "+15197566220",
      "status": "in-progress",
      "direction": "outbound",
      "duration": 1,
      "kind": "native",
      "callback": null,
      "meta": {},
      "started-at": "2020-01-01T00:00:00+00:00",
      "finished-at": null,
      "created-at": "2020-01-01T00:00:00+00:00",
      "updated-at": "2020-01-01T00:00:00+00:00"
    },
    "relationships": {
      "parent-call": {
        "data": {
          "type": "calls",
          "id": "KXq9WyvGHx8ueyWLooLkMP"
        }
      },
      "caller-id": {
        "data": {
          "type": "caller-ids",
          "id": "DECRngt4uXqsvCgbyM7d7p"
        }
      },
      "phone-number": {
        "data": null
      },
      "envelope": {
        "data": null
      },
      "contact": {
        "data": {
          "type": "contacts",
          "id": "KVLK7zmqDZxCtVYAb4mAqR"
        }
      },
      "voice-template": {
        "data": null
      },
      "memberships": {
        "data": []
      },
      "conference": {
        "data": null
      },
      "result": {
        "data": {
          "type": "call-results",
          "id": "SYv626tNVtprEQmMJDdr6B"
        }
      },
      "results": {
        "links": {
          "related": "/call-results?filter[call.id]=BojTqHDXSK7KcLCn5cZcc8"
        }
      },
      "recordings": {
        "links": {
          "related": "/recordings?filter[call.id]=BojTqHDXSK7KcLCn5cZcc8"
        }
      },
      "created-by": {
        "data": {
          "type": "memberships",
          "id": "C7xWERND6yBTpJJVHACzVf"
        }
      },
      "updated-by": {
        "data": {
          "type": "memberships",
          "id": "C7xWERND6yBTpJJVHACzVf"
        }
      }
    }
  }
}

Request Envelope Child Call

HideShow

Body

{
  "data": {
    "type": "calls",
    "attributes": {
      "to": "+15197566220",
      "action": "dial"
    },
    "relationships": {
      "parent-call": {
        "data": {
          "type": "calls",
          "id": "KXq9WyvGHx8ueyWLooLkMP"
        }
      },
      "caller-id": {
        "data": {
          "type": "caller-ids",
          "id": "DECRngt4uXqsvCgbyM7d7p"
        }
      },
      "envelope": {
        "data": {
          "type": "envelopes",
          "id": "FYSocwV2UCmoSLRGSLoXJJ"
        }
      }
    }
  }
}

Response 201

HideShow

Body

{
  "data": {
    "id": "BojTqHDXSK7KcLCn5cZcc8",
    "type": "calls",
    "attributes": {
      "from": "+18775550100",
      "to": "+15197566220",
      "status": "in-progress",
      "direction": "outbound",
      "duration": 1,
      "kind": "native",
      "callback": null,
      "meta": {},
      "started-at": "2020-01-01T00:00:00+00:00",
      "finished-at": null,
      "created-at": "2020-01-01T00:00:00+00:00",
      "updated-at": "2020-01-01T00:00:00+00:00"
    },
    "relationships": {
      "parent-call": {
        "data": {
          "type": "calls",
          "id": "KXq9WyvGHx8ueyWLooLkMP"
        }
      },
      "caller-id": {
        "data": {
          "type": "caller-ids",
          "id": "DECRngt4uXqsvCgbyM7d7p"
        }
      },
      "phone-number": {
        "data": null
      },
      "envelope": {
        "data": {
          "type": "envelopes",
          "id": "FYSocwV2UCmoSLRGSLoXJJ"
        }
      },
      "contact": {
        "data": {
          "type": "contacts",
          "id": "KVLK7zmqDZxCtVYAb4mAqR"
        }
      },
      "voice-template": {
        "data": null
      },
      "memberships": {
        "data": []
      },
      "conference": {
        "data": null
      },
      "result": {
        "data": {
          "type": "call-results",
          "id": "SYv626tNVtprEQmMJDdr6B"
        }
      },
      "results": {
        "links": {
          "related": "/call-results?filter[call.id]=BojTqHDXSK7KcLCn5cZcc8"
        }
      },
      "recordings": {
        "links": {
          "related": "/recordings?filter[call.id]=BojTqHDXSK7KcLCn5cZcc8"
        }
      },
      "created-by": {
        "data": {
          "type": "memberships",
          "id": "C7xWERND6yBTpJJVHACzVf"
        }
      },
      "updated-by": {
        "data": {
          "type": "memberships",
          "id": "C7xWERND6yBTpJJVHACzVf"
        }
      }
    }
  }
}

Request Envelope Combined Parent and Child Call

HideShow

Body

{
  "data": {
    "type": "calls",
    "attributes": {
      "from": "+18775550100",
      "to": "+15197566220",
      "action": "dial"
    },
    "relationships": {
      "caller-id": {
        "data": {
          "type": "caller-ids",
          "id": "DECRngt4uXqsvCgbyM7d7p"
        }
      },
      "envelope": {
        "data": {
          "type": "envelopes",
          "id": "FYSocwV2UCmoSLRGSLoXJJ"
        }
      }
    }
  }
}

Response 201

HideShow

Body

{
  "data": {
    "id": "BojTqHDXSK7KcLCn5cZcc8",
    "type": "calls",
    "attributes": {
      "from": "+18775550100",
      "to": "+15197566220",
      "status": "in-progress",
      "direction": "outbound",
      "duration": 1,
      "kind": "native",
      "callback": null,
      "meta": {},
      "started-at": "2020-01-01T00:00:00+00:00",
      "finished-at": null,
      "created-at": "2020-01-01T00:00:00+00:00",
      "updated-at": "2020-01-01T00:00:00+00:00"
    },
    "relationships": {
      "parent-call": {
        "data": {
          "type": "calls",
          "id": "KXq9WyvGHx8ueyWLooLkMP"
        }
      },
      "caller-id": {
        "data": {
          "type": "caller-ids",
          "id": "DECRngt4uXqsvCgbyM7d7p"
        }
      },
      "phone-number": {
        "data": null
      },
      "envelope": {
        "data": {
          "type": "envelopes",
          "id": "FYSocwV2UCmoSLRGSLoXJJ"
        }
      },
      "contact": {
        "data": {
          "type": "contacts",
          "id": "KVLK7zmqDZxCtVYAb4mAqR"
        }
      },
      "voice-template": {
        "data": null
      },
      "memberships": {
        "data": []
      },
      "conference": {
        "data": null
      },
      "result": {
        "data": {
          "type": "call-results",
          "id": "SYv626tNVtprEQmMJDdr6B"
        }
      },
      "results": {
        "links": {
          "related": "/call-results?filter[call.id]=BojTqHDXSK7KcLCn5cZcc8"
        }
      },
      "recordings": {
        "links": {
          "related": "/recordings?filter[call.id]=BojTqHDXSK7KcLCn5cZcc8"
        }
      },
      "created-by": {
        "data": {
          "type": "memberships",
          "id": "C7xWERND6yBTpJJVHACzVf"
        }
      },
      "updated-by": {
        "data": {
          "type": "memberships",
          "id": "C7xWERND6yBTpJJVHACzVf"
        }
      }
    }
  }
}

Call ¶

This resource manages retrieving a specified call instance.

Retrieve Call
GET`/calls/`

Retrieve an existing calls instance.

Example URI

GET https://api.omnigage.io/api/v1/calls/

Response 200

HideShow

Body

{
  "data": {
    "id": "BojTqHDXSK7KcLCn5cZcc8",
    "type": "calls",
    "attributes": {
      "from": "+18775550100",
      "to": "+15197566220",
      "status": "in-progress",
      "direction": "outbound",
      "duration": 1,
      "kind": "native",
      "callback": null,
      "meta": {},
      "started-at": "2020-01-01T00:00:00+00:00",
      "finished-at": null,
      "created-at": "2020-01-01T00:00:00+00:00",
      "updated-at": "2020-01-01T00:00:00+00:00"
    },
    "relationships": {
      "parent-call": {
        "data": {
          "type": "calls",
          "id": "KXq9WyvGHx8ueyWLooLkMP"
        }
      },
      "caller-id": {
        "data": {
          "type": "caller-ids",
          "id": "DECRngt4uXqsvCgbyM7d7p"
        }
      },
      "phone-number": {
        "data": null
      },
      "envelope": {
        "data": {
          "type": "envelopes",
          "id": "uLjLNq6tkPEhTuCUQsuipq"
        }
      },
      "contact": {
        "data": {
          "type": "contacts",
          "id": "KVLK7zmqDZxCtVYAb4mAqR"
        }
      },
      "voice-template": {
        "data": null
      },
      "memberships": {
        "data": []
      },
      "conference": {
        "data": null
      },
      "result": {
        "data": {
          "type": "call-results",
          "id": "SYv626tNVtprEQmMJDdr6B"
        }
      },
      "results": {
        "links": {
          "related": "/call-results?filter[call.id]=BojTqHDXSK7KcLCn5cZcc8"
        }
      },
      "recordings": {
        "links": {
          "related": "/recordings?filter[call.id]=BojTqHDXSK7KcLCn5cZcc8"
        }
      },
      "created-by": {
        "data": {
          "type": "memberships",
          "id": "C7xWERND6yBTpJJVHACzVf"
        }
      },
      "updated-by": {
        "data": {
          "type": "memberships",
          "id": "C7xWERND6yBTpJJVHACzVf"
        }
      }
    }
  }
}

Update Call
PATCH`/calls/`

Update an existing call instance.

Example URI

PATCH https://api.omnigage.io/api/v1/calls/

Request Hangup

HideShow

Body

{
  "data": {
    "id": "KXq9WyvGHx8ueyWLooLkMP",
    "type": "calls",
    "attributes": {
      "action": "hangup"
    }
  }
}

Response 202

HideShow

Body

{
  "data": {
    "id": "KXq9WyvGHx8ueyWLooLkMP",
    "type": "calls",
    "attributes": {
      "from": "+18775550100",
      "to": "+15197566220",
      "status": "complete",
      "direction": "outbound",
      "duration": 67,
      "kind": "native",
      "callback": null,
      "meta": {},
      "started-at": "2020-01-01T00:00:00+00:00",
      "finished-at": "2020-01-01T00:01:07+00:00",
      "created-at": "2020-01-01T00:00:00+00:00",
      "updated-at": "2020-01-01T00:00:00+00:00"
    },
    "relationships": {
      "parent-call": {
        "data": {
          "type": "calls",
          "id": "7wTGBhat3aHaDU3cQNAGnJ"
        }
      },
      "caller-id": {
        "data": {
          "type": "caller-ids",
          "id": "Lv8UgucPVGWcwZd9Hre9dn"
        }
      },
      "phone-number": {
        "data": null
      },
      "envelope": {
        "data": {
          "type": "envelopes",
          "id": "uLjLNq6tkPEhTuCUQsuipq"
        }
      },
      "contact": {
        "data": {
          "type": "contacts",
          "id": "KVLK7zmqDZxCtVYAb4mAqR"
        }
      },
      "voice-template": {
        "data": null
      },
      "memberships": {
        "data": []
      },
      "conference": {
        "data": null
      },
      "result": {
        "data": {
          "type": "call-results",
          "id": "SYv626tNVtprEQmMJDdr6B"
        }
      },
      "results": {
        "links": {
          "related": "/call-results?filter[call.id]=BojTqHDXSK7KcLCn5cZcc8"
        }
      },
      "recordings": {
        "links": {
          "related": "/recordings?filter[call.id]=BojTqHDXSK7KcLCn5cZcc8"
        }
      },
      "created-by": {
        "data": {
          "type": "memberships",
          "id": "C7xWERND6yBTpJJVHACzVf"
        }
      },
      "updated-by": {
        "data": {
          "type": "memberships",
          "id": "C7xWERND6yBTpJJVHACzVf"
        }
      }
    }
  }
}

Request Transfer

HideShow

Body

{
  "data": {
    "id": "KXq9WyvGHx8ueyWLooLkMP",
    "type": "calls",
    "attributes": {
      "action": "transfer"
    },
    "relationships": {
      "memberships": {
        "data": [
          {
            "type": "memberships",
            "id": "r58hTKT7AYS9dojRaF56o2"
          },
          {
            "type": "memberships",
            "id": "ZskVKR7C7WgdvytxeTSP3d"
          }
        ]
      }
    }
  }
}

Response 202

HideShow

Body

{
  "data": {
    "id": "KXq9WyvGHx8ueyWLooLkMP",
    "type": "calls",
    "attributes": {
      "action": "transfer",
      "from": "+18775550100",
      "to": "+15197566220",
      "status": "ringing",
      "direction": "outbound",
      "duration": 67,
      "kind": "native",
      "started-at": "2020-01-01T00:00:00+00:00",
      "finished-at": null,
      "created-at": "2020-01-01T00:00:00+00:00",
      "updated-at": "2020-01-01T00:00:00+00:00"
    },
    "relationships": {
      "parent-call": {
        "data": null
      },
      "caller-id": {
        "data": {
          "type": "caller-ids",
          "id": "Lv8UgucPVGWcwZd9Hre9dn"
        }
      },
      "phone-number": {
        "data": null
      },
      "envelope": {
        "data": null
      },
      "contact": {
        "data": {
          "type": "contacts",
          "id": "KVLK7zmqDZxCtVYAb4mAqR"
        }
      },
      "memberships": {
        "data": []
      },
      "voice-template": {
        "data": null
      },
      "conference": {
        "data": null
      },
      "result": {
        "data": {
          "type": "call-results",
          "id": "SYv626tNVtprEQmMJDdr6B"
        }
      },
      "results": {
        "links": {
          "related": "/call-results?filter[call.id]=BojTqHDXSK7KcLCn5cZcc8"
        }
      },
      "recordings": {
        "links": {
          "related": "/recordings?filter[call.id]=BojTqHDXSK7KcLCn5cZcc8"
        }
      },
      "created-by": {
        "data": {
          "type": "memberships",
          "id": "C7xWERND6yBTpJJVHACzVf"
        }
      },
      "updated-by": {
        "data": {
          "type": "memberships",
          "id": "C7xWERND6yBTpJJVHACzVf"
        }
      }
    }
  }
}

Request Record Message

HideShow

Body

{
  "data": {
    "id": "KXq9WyvGHx8ueyWLooLkMP",
    "type": "calls",
    "attributes": {
      "action": "record"
    }
  }
}

Response 202

HideShow

Body

{
  "data": {
    "id": "KXq9WyvGHx8ueyWLooLkMP",
    "type": "calls",
    "attributes": {
      "from": null,
      "to": "+15197566220",
      "status": "in-progress",
      "direction": "outbound",
      "duration": 67,
      "kind": "native",
      "callback": null,
      "meta": {},
      "started-at": "2020-01-01T00:00:00+00:00",
      "finished-at": null,
      "created-at": "2020-01-01T00:00:00+00:00",
      "updated-at": "2020-01-01T00:00:00+00:00"
    },
    "relationships": {
      "parent-call": {
        "data": null
      },
      "caller-id": {
        "data": null
      },
      "phone-number": {
        "data": null
      },
      "envelope": {
        "data": null
      },
      "contact": {
        "data": null
      },
      "voice-template": {
        "data": null
      },
      "memberships": {
        "data": []
      },
      "conference": {
        "data": null
      },
      "result": {
        "data": {
          "type": "call-results",
          "id": "SYv626tNVtprEQmMJDdr6B"
        }
      },
      "results": {
        "links": {
          "related": "/call-results?filter[call.id]=BojTqHDXSK7KcLCn5cZcc8"
        }
      },
      "recordings": {
        "links": {
          "related": "/recordings?filter[call.id]=BojTqHDXSK7KcLCn5cZcc8"
        }
      },
      "created-by": {
        "data": {
          "type": "memberships",
          "id": "C7xWERND6yBTpJJVHACzVf"
        }
      },
      "updated-by": {
        "data": {
          "type": "memberships",
          "id": "C7xWERND6yBTpJJVHACzVf"
        }
      }
    }
  }
}

Request Play Message

HideShow

Body

{
  "data": {
    "id": "KXq9WyvGHx8ueyWLooLkMP",
    "type": "calls",
    "attributes": {
      "action": "play"
    },
    "relationships": {
      "voice-template": {
        "data": {
          "type": "voice-templates",
          "id": "RyrUsV4MXEicu8Eo9DZpLM"
        }
      }
    }
  }
}

Response 202

HideShow

Body

{
  "data": {
    "id": "KXq9WyvGHx8ueyWLooLkMP",
    "type": "calls",
    "attributes": {
      "from": null,
      "to": "+15197566220",
      "status": "in-progress",
      "direction": "outbound",
      "duration": 67,
      "kind": "native",
      "callback": null,
      "meta": {},
      "started-at": "2020-01-01T00:00:00+00:00",
      "finished-at": null,
      "created-at": "2020-01-01T00:00:00+00:00",
      "updated-at": "2020-01-01T00:00:00+00:00"
    },
    "relationships": {
      "parent-call": {
        "data": null
      },
      "caller-id": {
        "data": null
      },
      "phone-number": {
        "data": null
      },
      "envelope": {
        "data": null
      },
      "contact": {
        "data": null
      },
      "voice-template": {
        "data": null
      },
      "memberships": {
        "data": []
      },
      "conference": {
        "data": null
      },
      "result": {
        "data": {
          "type": "call-results",
          "id": "SYv626tNVtprEQmMJDdr6B"
        }
      },
      "results": {
        "links": {
          "related": "/call-results?filter[call.id]=BojTqHDXSK7KcLCn5cZcc8"
        }
      },
      "recordings": {
        "links": {
          "related": "/recordings?filter[call.id]=BojTqHDXSK7KcLCn5cZcc8"
        }
      },
      "created-by": {
        "data": {
          "type": "memberships",
          "id": "C7xWERND6yBTpJJVHACzVf"
        }
      },
      "updated-by": {
        "data": {
          "type": "memberships",
          "id": "C7xWERND6yBTpJJVHACzVf"
        }
      }
    }
  }
}

Request Voicemail Drop

HideShow

Body

{
  "data": {
    "id": "KXq9WyvGHx8ueyWLooLkMP",
    "type": "calls",
    "attributes": {
      "action": "voicemail-drop"
    },
    "relationships": {
      "voice-template": {
        "data": {
          "type": "voice-templates",
          "id": "RyrUsV4MXEicu8Eo9DZpLM"
        }
      }
    }
  }
}

Response 202

HideShow

Body

{
  "data": {
    "id": "KXq9WyvGHx8ueyWLooLkMP",
    "type": "calls",
    "attributes": {
      "from": "+18775550100",
      "to": "+15197566220",
      "status": "in-progress",
      "direction": "outbound",
      "duration": 67,
      "kind": "native",
      "callback": null,
      "has-recording": false,
      "meta": {},
      "started-at": "2020-01-01T00:00:00+00:00",
      "finished-at": null,
      "created-at": "2020-01-01T00:00:00+00:00",
      "updated-at": "2020-01-01T00:00:00+00:00"
    },
    "relationships": {
      "parent-call": {
        "data": {
          "type": "calls",
          "id": "7wTGBhat3aHaDU3cQNAGnJ"
        }
      },
      "caller-id": {
        "data": {
          "type": "caller-ids",
          "id": "Lv8UgucPVGWcwZd9Hre9dn"
        }
      },
      "phone-number": {
        "data": null
      },
      "envelope": {
        "data": {
          "type": "envelopes",
          "id": "uLjLNq6tkPEhTuCUQsuipq"
        }
      },
      "contact": {
        "data": {
          "type": "contacts",
          "id": "KVLK7zmqDZxCtVYAb4mAqR"
        }
      },
      "voice-template": {
        "data": null
      },
      "memberships": {
        "data": []
      },
      "conference": {
        "data": null
      },
      "result": {
        "data": {
          "type": "call-results",
          "id": "SYv626tNVtprEQmMJDdr6B"
        }
      },
      "results": {
        "links": {
          "related": "/call-results?filter[call.id]=BojTqHDXSK7KcLCn5cZcc8"
        }
      },
      "recordings": {
        "links": {
          "related": "/recordings?filter[call.id]=BojTqHDXSK7KcLCn5cZcc8"
        }
      },
      "created-by": {
        "data": {
          "type": "memberships",
          "id": "C7xWERND6yBTpJJVHACzVf"
        }
      },
      "updated-by": {
        "data": {
          "type": "memberships",
          "id": "C7xWERND6yBTpJJVHACzVf"
        }
      }
    }
  }
}

Call Result Collection ¶

This resource manages the retrieval of call result collections.

Note: Must filter by either call or envelope. Results are limited based on the membership’s collaborator access to the call relationship (determined by caller-ids or phone-numbers) or envelope relationship (determined by engagements).

Retrieve Call Results
GET`/call-results{?filter,include,sort,page}`

Retrieve a collection of call results.

Example URI

GET https://api.omnigage.io/api/v1/call-results?filter=1&include=&sort=created-at&page=10

URI Parameters

HideShow

filter: string (optional) Example: 1
Filter on one or more fields using comma separated values filter[field]=1,2.
include: string (optional)
Include one ore more related relationships using comma separated name.
sort: string (optional) Example: created-at
Sort on one or more fields using comma separated values.
page: string (optional) Example: 10
Use page[limit]=10 to reduce the number of instances returned. Use ?page[offset]=10 to skip this many instances.

Response 200

HideShow

Body

{
  "links": {
    "self": "/call-results?filter[call.id]=DJibkCtTD5vc3ALpqNhDXf&",
    "next": "/call-results?filter[call.id]=DJibkCtTD5vc3ALpqNhDXf&page[offset]=10",
    "last": "/call-results?filter[call.id]=DJibkCtTD5vc3ALpqNhDXf&page[offset]=100"
  },
  "meta": {
    "total": 110
  },
  "data": [
    {
      "id": "RaF56o2r58hTKT7AYS9doj",
      "type": "call-results",
      "attributes": {
        "kind": "prompt",
        "digits": "1",
        "speech": null,
        "phone-number": null,
        "hold-time": null,
        "created-at": "2020-01-01T00:00:00+00:00",
        "updated-at": "2020-01-01T00:00:00+00:00"
      },
      "relationships": {
        "call": {
          "data": {
            "type": "calls",
            "id": "vytxeTZskVKR7C7WgdSP3d"
          }
        },
        "envelope": {
          "data": {
            "type": "envelopes",
            "id": "LUBMPzRVcyD2iWa5VoYjGP"
          }
        },
        "trigger": {
          "data": {
            "type": "triggers",
            "id": "r58hTKT7AYS9dojRaF56o2"
          }
        },
        "voice-message": {
          "data": null
        },
        "recording": {
          "data": null
        },
        "conference": {
          "data": null
        },
        "transition": {
          "data": null
        }
      }
    }
  ]
}

Call Result ¶

This resource manages retrieving a specified call result instance.

Retrieve Call Result
GET`/call-results/`

Retrieve an existing call result instance.

Example URI

GET https://api.omnigage.io/api/v1/call-results/

Response 200

HideShow

Body

{
  "data": {
    "id": "RaF56o2r58hTKT7AYS9doj",
    "type": "call-results",
    "attributes": {
      "kind": "prompt",
      "digits": "1",
      "speech": null,
      "phone-number": null,
      "hold-time": null,
      "created-at": "2020-01-01T00:00:00+00:00",
      "updated-at": "2020-01-01T00:00:00+00:00"
    },
    "relationships": {
      "call": {
        "data": {
          "type": "calls",
          "id": "vytxeTZskVKR7C7WgdSP3d"
        }
      },
      "envelope": {
        "data": {
          "type": "envelopes",
          "id": "LUBMPzRVcyD2iWa5VoYjGP"
        }
      },
      "trigger": {
        "data": {
          "type": "triggers",
          "id": "r58hTKT7AYS9dojRaF56o2"
        }
      },
      "voice-message": {
        "data": null
      },
      "recording": {
        "data": null
      },
      "conference": {
        "data": null
      },
      "transition": {
        "data": null
      }
    }
  }
}

Recording Collection ¶

This resource manages the retrieval of recording collections.

Create Recording
POST`/recordings`

Create a new recordings instance.

Note: Either an active call or conference is required to begin a recording.

Example URI

POST https://api.omnigage.io/api/v1/recordings

Request Call Recording

HideShow

Body

{
  "data": {
    "type": "recordings",
    "relationships": {
      "call": {
        "data": {
          "type": "calls",
          "id": "DQdtkEVYLRomQrjU2KWexB"
        }
      }
    }
  }
}

Response 201

HideShow

Body

{
  "data": {
    "id": "RaF56o2r58hTKT7AYS9doj",
    "type": "recordings",
    "attributes": {
      "status": "completed",
      "duration": 147,
      "transcript": null,
      "created-at": "2020-01-01T00:00:00+00:00",
      "updated-at": "2020-01-01T00:00:00+00:00"
    },
    "relationships": {
      "file": {
        "data": {
          "type": "files",
          "id": "MxjW4f4Jjqngu5383UoHoj"
        }
      },
      "call": {
        "data": {
          "type": "calls",
          "id": "DQdtkEVYLRomQrjU2KWexB"
        }
      },
      "conference": {
        "data": null
      },
      "created-by": {
        "data": {
          "type": "memberships",
          "id": "C7xWERND6yBTpJJVHACzVf"
        }
      },
      "updated-by": {
        "data": {
          "type": "memberships",
          "id": "C7xWERND6yBTpJJVHACzVf"
        }
      }
    }
  }
}

Retrieve Recordings
GET`/recordings{?include,filter,sort,page}`

Retrieve a collection of recordings.

Note: Filtering on call.id or conference.id is required.

Example URI

GET https://api.omnigage.io/api/v1/recordings?include=&filter=&sort=created-at&page=10

URI Parameters

HideShow

filter: string (required)
Filter on one or more fields using comma separated values filter[call.id]=DJibkCtTD5vc3ALpqNhDXf.
include: string (optional)
Include one ore more related relationships using comma separated name.
sort: string (optional) Example: created-at
Sort on one or more fields using comma separated values.
page: string (optional) Example: 10
Use page[limit]=10 to reduce the number of instances returned. Use ?page[offset]=10 to skip this many instances.

Response 200

HideShow

Body

{
  "links": {
    "self": "/recordings?filter[call.id]=BojTqHDXSK7KcLCn5cZcc8",
    "next": "/recordings?filter[call.id]=BojTqHDXSK7KcLCn5cZcc8&page[offset]=10",
    "last": "/recordings?filter[call.id]=BojTqHDXSK7KcLCn5cZcc8&page[offset]=100"
  },
  "meta": {
    "total": 10
  },
  "data": [
    {
      "id": "RaF56o2r58hTKT7AYS9doj",
      "type": "recordings",
      "attributes": {
        "status": "completed",
        "duration": 147,
        "transcript": null,
        "created-at": "2020-01-01T00:00:00+00:00",
        "updated-at": "2020-01-01T00:00:00+00:00"
      },
      "relationships": {
        "file": {
          "data": {
            "type": "files",
            "id": "MxjW4f4Jjqngu5383UoHoj"
          }
        },
        "call": {
          "data": {
            "type": "calls",
            "id": "DQdtkEVYLRomQrjU2KWexB"
          }
        },
        "conference": {
          "data": null
        },
        "created-by": {
          "data": {
            "type": "memberships",
            "id": "C7xWERND6yBTpJJVHACzVf"
          }
        },
        "updated-by": {
          "data": {
            "type": "memberships",
            "id": "C7xWERND6yBTpJJVHACzVf"
          }
        }
      }
    }
  ]
}

Recording ¶

This resource manages updating and retrieving a specified recording instance.

Retrieve Recording
GET`/recordings/`

Retrieve an existing recording instance.

Example URI

GET https://api.omnigage.io/api/v1/recordings/

Response 200

HideShow

Body

{
  "data": {
    "id": "RaF56o2r58hTKT7AYS9doj",
    "type": "recordings",
    "attributes": {
      "status": "completed",
      "duration": 147,
      "transcript": null,
      "created-at": "2020-01-01T00:00:00+00:00",
      "updated-at": "2020-01-01T00:00:00+00:00"
    },
    "relationships": {
      "file": {
        "data": {
          "type": "files",
          "id": "MxjW4f4Jjqngu5383UoHoj"
        }
      },
      "call": {
        "data": {
          "type": "calls",
          "id": "DQdtkEVYLRomQrjU2KWexB"
        }
      },
      "conference": {
        "data": null
      },
      "created-by": {
        "data": {
          "type": "memberships",
          "id": "C7xWERND6yBTpJJVHACzVf"
        }
      },
      "updated-by": {
        "data": {
          "type": "memberships",
          "id": "C7xWERND6yBTpJJVHACzVf"
        }
      }
    }
  }
}

Update Recording
PATCH`/recordings/`

Update an existing recording instance.

Example URI

PATCH https://api.omnigage.io/api/v1/recordings/

Request

HideShow

Body

{
  "data": {
    "id": "RaF56o2r58hTKT7AYS9doj",
    "type": "recordings",
    "attributes": {
      "status": "completed",
      "duration": 147,
      "transcript": null,
      "created-at": "2020-01-01T00:00:00+00:00",
      "updated-at": "2020-01-01T00:00:00+00:00"
    },
    "relationships": {
      "file": {
        "data": {
          "type": "files",
          "id": "MxjW4f4Jjqngu5383UoHoj"
        }
      },
      "call": {
        "data": {
          "type": "calls",
          "id": "DQdtkEVYLRomQrjU2KWexB"
        }
      },
      "conference": {
        "data": null
      },
      "created-by": {
        "data": {
          "type": "memberships",
          "id": "C7xWERND6yBTpJJVHACzVf"
        }
      },
      "updated-by": {
        "data": {
          "type": "memberships",
          "id": "C7xWERND6yBTpJJVHACzVf"
        }
      }
    }
  }
}

Response 202

HideShow

Body

{
  "data": {
    "id": "RaF56o2r58hTKT7AYS9doj",
    "type": "recordings",
    "attributes": {
      "status": "completed",
      "duration": 147,
      "transcript": null,
      "created-at": "2020-01-01T00:00:00+00:00",
      "updated-at": "2020-01-01T00:00:00+00:00"
    },
    "relationships": {
      "file": {
        "data": {
          "type": "files",
          "id": "MxjW4f4Jjqngu5383UoHoj"
        }
      },
      "call": {
        "data": {
          "type": "calls",
          "id": "DQdtkEVYLRomQrjU2KWexB"
        }
      },
      "conference": {
        "data": null
      },
      "created-by": {
        "data": {
          "type": "memberships",
          "id": "C7xWERND6yBTpJJVHACzVf"
        }
      },
      "updated-by": {
        "data": {
          "type": "memberships",
          "id": "C7xWERND6yBTpJJVHACzVf"
        }
      }
    }
  }
}

Voice Message Collection ¶

Voice messages are used to keep track of audio or TTS played on a call.

Note: Instances are returned based on membership access to the call relationship.

Retrieve Voice Messages
GET`/voice-messages{?include,filter,sort,page}`

Retrieve a collection of voice messages.

Example URI

GET https://api.omnigage.io/api/v1/voice-messages?include=&filter=1&sort=created-at&page=10

URI Parameters

HideShow

include: string (optional)
Include one ore more related relationships using comma separated name.
sort: string (optional) Example: created-at
Sort on one or more fields using comma separated values.
filter: string (optional) Example: 1
Filter on one or more fields using comma separated values filter[field]=1,2.
page: string (optional) Example: 10
Use page[limit]=10 to reduce the number of instances returned. Use ?page[offset]=10 to skip this many instances.

Response 200

HideShow

Body

{
  "links": {
    "self": "/voice-messages",
    "next": "/voice-messages?page[offset]=10",
    "last": "/voice-messages?page[offset]=100"
  },
  "meta": {
    "total": 110
  },
  "data": [
    {
      "id": "RaF56o2r58hTKT7AYS9doj",
      "type": "voice-messages",
      "attributes": {
        "kind": "audio",
        "body": null,
        "created-at": "2020-01-01T00:00:00+00:00",
        "updated-at": "2020-01-01T00:00:00+00:00"
      },
      "relationships": {
        "call": {
          "data": {
            "type": "calls",
            "id": "m2VfRvMbpp47yiJoXPRu4U"
          }
        },
        "file": {
          "data": {
            "type": "files",
            "id": "ZskVKR7C7WgdvytxeTSP3d"
          }
        },
        "voice-template": {
          "data": {
            "type": "voice-templates",
            "id": "nGQHPQuBgTTAPnpGHojYtR"
          }
        }
      }
    }
  ]
}

Voice Message ¶

This resource retrieves a specified voice message instance.

Retrieve Voice Message
GET`/voice-messages/`

Retrieve an existing voice message instance.

Example URI

GET https://api.omnigage.io/api/v1/voice-messages/

Response 200

HideShow

Body

{
  "data": {
    "id": "RaF56o2r58hTKT7AYS9doj",
    "type": "voice-messages",
    "attributes": {
      "kind": "audio",
      "body": null,
      "created-at": "2020-01-01T00:00:00+00:00",
      "updated-at": "2020-01-01T00:00:00+00:00"
    },
    "relationships": {
      "call": {
        "data": {
          "type": "calls",
          "id": "m2VfRvMbpp47yiJoXPRu4U"
        }
      },
      "file": {
        "data": {
          "type": "files",
          "id": "ZskVKR7C7WgdvytxeTSP3d"
        }
      },
      "voice-template": {
        "data": {
          "type": "voice-templates",
          "id": "nGQHPQuBgTTAPnpGHojYtR"
        }
      }
    }
  }
}

Voice Template Collection ¶

This resource manages the retrieval of voice template collections and the creation of voice template instances.

Retrieve Voice Templates
GET`/voice-templates{?include,filter,sort,page}`

Retrieve a collection of voice templates.

Example URI

GET https://api.omnigage.io/api/v1/voice-templates?include=&filter=1&sort=created-at&page=10

URI Parameters

HideShow

include: string (optional)
Include one ore more related relationships using comma separated name.
sort: string (optional) Example: created-at
Sort on one or more fields using comma separated values.
filter: string (optional) Example: 1
Filter on one or more fields using comma separated values filter[field]=1,2.
page: string (optional) Example: 10
Use page[limit]=10 to reduce the number of instances returned. Use ?page[offset]=10 to skip this many instances.

Response 200

HideShow

Body

{
  "links": {
    "self": "/voice-templates",
    "next": "/voice-templates?page[offset]=10",
    "last": "/voice-templates?page[offset]=100"
  },
  "meta": {
    "total": 110
  },
  "data": [
    {
      "id": "RaF56o2r58hTKT7AYS9doj",
      "type": "voice-templates",
      "attributes": {
        "name": "Spring Specials",
        "kind": "audio",
        "body": null,
        "status": "completed",
        "is-archived": false,
        "created-at": "2020-01-01T00:00:00+00:00",
        "updated-at": "2020-01-01T00:00:00+00:00",
        "deleted-at": null
      },
      "relationships": {
        "file": {
          "data": {
            "type": "files",
            "id": "ZskVKR7C7WgdvytxeTSP3d"
          }
        },
        "tags": {
          "data": [
            {
              "type": "tags",
              "id": "WyUXyQqjyuz4UN5X7yAzW7"
            },
            {
              "type": "tags",
              "id": "vL7kCsN495rVZCLcJjUhXx"
            }
          ]
        },
        "primary": {
          "data": {
            "type": "voice-templates",
            "id": "RaF56o2r58hTKT7AYS9doj"
          }
        },
        "revision": {
          "data": {
            "type": "voice-templates",
            "id": "KR7C7WgdvytxeTSP3dZskV"
          }
        },
        "revisions": {
          "links": {
            "related": "voice-templates/RaF56o2r58hTKT7AYS9doj/revisions"
          }
        },
        "language": {
          "data": {
            "type": "languages",
            "id": "grSFiiqc3PK5Drkio9cZxx"
          }
        },
        "created-by": {
          "data": {
            "type": "memberships",
            "id": "C7xWERND6yBTpJJVHACzVf"
          }
        },
        "updated-by": {
          "data": {
            "type": "memberships",
            "id": "C7xWERND6yBTpJJVHACzVf"
          }
        },
        "deleted-by": {
          "data": null
        }
      }
    }
  ]
}

Create Voice Template
POST`/voice-templates`

Create a new voice template instance.

The body supports the following variables:

{{first-name}}: Alexander (string, optional)
{{last-name}}: Bell (string, optional)
{{title}}: Mr. (string, optional)
{{company}}: Bell Company (string, optional)
{{birthday}}: 1847-03-03 (string, optional) - ISO 8601 YYYY-MM-DD
{{gender}} (enum[string], optional)
- Members
  - female
  - male

Example URI

POST https://api.omnigage.io/api/v1/voice-templates

Request

HideShow

Body

{
  "data": {
    "type": "voice-templates",
    "attributes": {
      "name": "Spring Specials",
      "kind": "audio"
    },
    "relationships": {
      "uploads": {
        "data": {
          "type": "uploads",
          "id": "RaF56o2r58hTKT7AYS9doj"
        }
      },
      "tags": {
        "data": [
          {
            "type": "tags",
            "id": "WyUXyQqjyuz4UN5X7yAzW7"
          },
          {
            "type": "tags",
            "id": "vL7kCsN495rVZCLcJjUhXx"
          }
        ]
      }
    }
  }
}

Response 201

HideShow

Body

{
  "data": {
    "id": "RaF56o2r58hTKT7AYS9doj",
    "type": "voice-templates",
    "attributes": {
      "name": "Spring Specials",
      "kind": "audio",
      "status": "completed",
      "body": null,
      "is-archived": false,
      "created-at": "2020-01-01T00:00:00+00:00",
      "updated-at": "2020-01-01T00:00:00+00:00",
      "deleted-at": null
    },
    "relationships": {
      "file": {
        "data": {
          "type": "files",
          "id": "ZskVKR7C7WgdvytxeTSP3d"
        }
      },
      "tags": {
        "data": [
          {
            "type": "tags",
            "id": "WyUXyQqjyuz4UN5X7yAzW7"
          },
          {
            "type": "tags",
            "id": "vL7kCsN495rVZCLcJjUhXx"
          }
        ]
      },
      "primary": {
        "data": {
          "type": "voice-templates",
          "id": "RaF56o2r58hTKT7AYS9doj"
        }
      },
      "revision": {
        "data": {
          "type": "voice-templates",
          "id": "KR7C7WgdvytxeTSP3dZskV"
        }
      },
      "revisions": {
        "links": {
          "related": "voice-templates/RaF56o2r58hTKT7AYS9doj/revisions"
        }
      },
      "language": {
        "data": {
          "type": "languages",
          "id": "grSFiiqc3PK5Drkio9cZxx"
        }
      },
      "created-by": {
        "data": {
          "type": "memberships",
          "id": "C7xWERND6yBTpJJVHACzVf"
        }
      },
      "updated-by": {
        "data": {
          "type": "memberships",
          "id": "C7xWERND6yBTpJJVHACzVf"
        }
      },
      "deleted-by": {
        "data": null
      }
    }
  }
}

Voice Template ¶

This resource manages updating and retrieving a specified voice template instance.

The following audio formats are supported: - audio/mpeg: mpeg layer 3 audio - audio/wav: wav format audio - audio/wave: wav format audio - audio/x-wav: wav format audio - audio/aiff: audio interchange file format - audio/x-aifc: audio interchange file format - audio/x-aiff: audio interchange file format - audio/x-gsm: GSM audio format - audio/gsm: GSM audio format - audio/ulaw: μ-law audio format

Retrieve Voice Template
GET`/voice-templates/`

Retrieve an existing voice template instance.

Example URI

GET https://api.omnigage.io/api/v1/voice-templates/

Response 200

HideShow

Body

{
  "data": {
    "id": "RaF56o2r58hTKT7AYS9doj",
    "type": "voice-templates",
    "attributes": {
      "name": "Spring Specials",
      "kind": "audio",
      "status": "completed",
      "body": null,
      "is-archived": false,
      "created-at": "2020-01-01T00:00:00+00:00",
      "updated-at": "2020-01-01T00:00:00+00:00",
      "deleted-at": null
    },
    "relationships": {
      "file": {
        "data": {
          "type": "files",
          "id": "ZskVKR7C7WgdvytxeTSP3d"
        }
      },
      "tags": {
        "data": [
          {
            "type": "tags",
            "id": "WyUXyQqjyuz4UN5X7yAzW7"
          },
          {
            "type": "tags",
            "id": "vL7kCsN495rVZCLcJjUhXx"
          }
        ]
      },
      "primary": {
        "data": {
          "type": "voice-templates",
          "id": "RaF56o2r58hTKT7AYS9doj"
        }
      },
      "revision": {
        "data": {
          "type": "voice-templates",
          "id": "KR7C7WgdvytxeTSP3dZskV"
        }
      },
      "revisions": {
        "links": {
          "related": "voice-templates/RaF56o2r58hTKT7AYS9doj/revisions"
        }
      },
      "language": {
        "data": {
          "type": "languages",
          "id": "grSFiiqc3PK5Drkio9cZxx"
        }
      },
      "created-by": {
        "data": {
          "type": "memberships",
          "id": "C7xWERND6yBTpJJVHACzVf"
        }
      },
      "updated-by": {
        "data": {
          "type": "memberships",
          "id": "C7xWERND6yBTpJJVHACzVf"
        }
      },
      "deleted-by": {
        "data": null
      }
    }
  }
}

Update Voice Template
PATCH`/voice-templates/`

Update an existing voice template instance.

Note: Updating will create a new revision. This includes adding or archiving files.

Example URI

PATCH https://api.omnigage.io/api/v1/voice-templates/

Request

HideShow

Body

{
  "data": {
    "id": "RaF56o2r58hTKT7AYS9doj",
    "type": "voice-templates",
    "attributes": {
      "name": "Spring Specials",
      "kind": "audio",
      "status": "completed",
      "body": null,
      "is-archived": false,
      "created-at": "2020-01-01T00:00:00+00:00",
      "updated-at": "2020-01-01T00:00:00+00:00",
      "deleted-at": null
    },
    "relationships": {
      "file": {
        "data": {
          "type": "files",
          "id": "ZskVKR7C7WgdvytxeTSP3d"
        }
      },
      "tags": {
        "data": [
          {
            "type": "tags",
            "id": "WyUXyQqjyuz4UN5X7yAzW7"
          },
          {
            "type": "tags",
            "id": "vL7kCsN495rVZCLcJjUhXx"
          }
        ]
      },
      "primary": {
        "data": {
          "type": "voice-templates",
          "id": "RaF56o2r58hTKT7AYS9doj"
        }
      },
      "revision": {
        "data": {
          "type": "voice-templates",
          "id": "KR7C7WgdvytxeTSP3dZskV"
        }
      },
      "revisions": {
        "links": {
          "related": "voice-templates/RaF56o2r58hTKT7AYS9doj/revisions"
        }
      },
      "language": {
        "data": {
          "type": "languages",
          "id": "grSFiiqc3PK5Drkio9cZxx"
        }
      },
      "created-by": {
        "data": {
          "type": "memberships",
          "id": "C7xWERND6yBTpJJVHACzVf"
        }
      },
      "updated-by": {
        "data": {
          "type": "memberships",
          "id": "C7xWERND6yBTpJJVHACzVf"
        }
      },
      "deleted-by": {
        "data": null
      }
    }
  }
}

Response 202

HideShow

Body

{
  "data": {
    "id": "RaF56o2r58hTKT7AYS9doj",
    "type": "voice-templates",
    "attributes": {
      "name": "Spring Specials",
      "kind": "audio",
      "status": "completed",
      "body": null,
      "is-archived": false,
      "created-at": "2020-01-01T00:00:00+00:00",
      "updated-at": "2020-01-01T00:00:00+00:00",
      "deleted-at": null
    },
    "relationships": {
      "file": {
        "data": {
          "type": "files",
          "id": "ZskVKR7C7WgdvytxeTSP3d"
        }
      },
      "tags": {
        "data": [
          {
            "type": "tags",
            "id": "WyUXyQqjyuz4UN5X7yAzW7"
          },
          {
            "type": "tags",
            "id": "vL7kCsN495rVZCLcJjUhXx"
          }
        ]
      },
      "primary": {
        "data": {
          "type": "voice-templates",
          "id": "RaF56o2r58hTKT7AYS9doj"
        }
      },
      "revision": {
        "data": {
          "type": "voice-templates",
          "id": "KR7C7WgdvytxeTSP3dZskV"
        }
      },
      "revisions": {
        "links": {
          "related": "voice-templates/RaF56o2r58hTKT7AYS9doj/revisions"
        }
      },
      "language": {
        "data": {
          "type": "languages",
          "id": "grSFiiqc3PK5Drkio9cZxx"
        }
      },
      "created-by": {
        "data": {
          "type": "memberships",
          "id": "C7xWERND6yBTpJJVHACzVf"
        }
      },
      "updated-by": {
        "data": {
          "type": "memberships",
          "id": "C7xWERND6yBTpJJVHACzVf"
        }
      },
      "deleted-by": {
        "data": null
      }
    }
  }
}

Request Template from Call

HideShow

Body

{
  "data": {
    "id": "RaF56o2r58hTKT7AYS9doj",
    "type": "voice-templates",
    "relationships": {
      "call": {
        "data": {
          "type": "calls",
          "id": "SQ5U9eifLSPdYHqPesPwuh"
        }
      }
    }
  }
}

Response 202

HideShow

Body

{
  "data": {
    "id": "RaF56o2r58hTKT7AYS9doj",
    "type": "voice-templates",
    "attributes": {
      "name": "Spring Specials",
      "kind": "audio",
      "status": "completed",
      "body": null,
      "is-archived": false,
      "created-at": "2020-01-01T00:00:00+00:00",
      "updated-at": "2020-01-01T00:00:00+00:00",
      "deleted-at": null
    },
    "relationships": {
      "file": {
        "data": {
          "type": "files",
          "id": "ZskVKR7C7WgdvytxeTSP3d"
        }
      },
      "tags": {
        "data": [
          {
            "type": "tags",
            "id": "WyUXyQqjyuz4UN5X7yAzW7"
          },
          {
            "type": "tags",
            "id": "vL7kCsN495rVZCLcJjUhXx"
          }
        ]
      },
      "primary": {
        "data": {
          "type": "voice-templates",
          "id": "RaF56o2r58hTKT7AYS9doj"
        }
      },
      "revision": {
        "data": {
          "type": "voice-templates",
          "id": "KR7C7WgdvytxeTSP3dZskV"
        }
      },
      "revisions": {
        "links": {
          "related": "voice-templates/RaF56o2r58hTKT7AYS9doj/revisions"
        }
      },
      "language": {
        "data": {
          "type": "languages",
          "id": "grSFiiqc3PK5Drkio9cZxx"
        }
      },
      "created-by": {
        "data": {
          "type": "memberships",
          "id": "C7xWERND6yBTpJJVHACzVf"
        }
      },
      "updated-by": {
        "data": {
          "type": "memberships",
          "id": "C7xWERND6yBTpJJVHACzVf"
        }
      },
      "deleted-by": {
        "data": null
      }
    }
  }
}

Delete Voice Template
DELETE`/voice-templates/`

Sets the is-archived field’s value to true. Note: The actual instance is not deleted.

Example URI

DELETE https://api.omnigage.io/api/v1/voice-templates/

Response 204

Voice Template Revision Collection ¶

This resource manages the retrieval of a given voice template’s revisions.

Note: Revisions cannot be edited or deleted.

Retrieve Voice Template Revisions
GET`/voice-templates/revisions{?include,filter,sort,page}`

Retrieve a collection of voice template revisions.

Example URI

GET https://api.omnigage.io/api/v1/voice-templates/revisions?include=&filter=1&sort=created-at&page=10

URI Parameters

HideShow

include: string (optional)
Include one ore more related relationships using comma separated name.
sort: string (optional) Example: created-at
Sort on one or more fields using comma separated values.
filter: string (optional) Example: 1
Filter on one or more fields using comma separated values filter[field]=1,2.
page: string (optional) Example: 10
Use page[limit]=10 to reduce the number of instances returned. Use ?page[offset]=10 to skip this many instances.

Response 200

HideShow

Body

{
  "links": {
    "self": "/voice-templates",
    "next": "/voice-templates?page[offset]=10",
    "last": "/voice-templates?page[offset]=100"
  },
  "meta": {
    "total": 110
  },
  "data": [
    {
      "id": "RaF56o2r58hTKT7AYS9doj",
      "type": "voice-templates",
      "attributes": {
        "name": "Spring Specials",
        "kind": "audio",
        "body": null,
        "status": "completed",
        "is-archived": false,
        "created-at": "2020-01-01T00:00:00+00:00",
        "updated-at": "2020-01-01T00:00:00+00:00",
        "deleted-at": null
      },
      "relationships": {
        "file": {
          "data": {
            "type": "files",
            "id": "ZskVKR7C7WgdvytxeTSP3d"
          }
        },
        "tags": {
          "data": [
            {
              "type": "tags",
              "id": "WyUXyQqjyuz4UN5X7yAzW7"
            },
            {
              "type": "tags",
              "id": "vL7kCsN495rVZCLcJjUhXx"
            }
          ]
        },
        "primary": {
          "data": {
            "type": "voice-templates",
            "id": "RaF56o2r58hTKT7AYS9doj"
          }
        },
        "revision": {
          "data": {
            "type": "voice-templates",
            "id": "KR7C7WgdvytxeTSP3dZskV"
          }
        },
        "revisions": {
          "links": {
            "related": "voice-templates/RaF56o2r58hTKT7AYS9doj/revisions"
          }
        },
        "language": {
          "data": {
            "type": "languages",
            "id": "grSFiiqc3PK5Drkio9cZxx"
          }
        },
        "created-by": {
          "data": {
            "type": "memberships",
            "id": "C7xWERND6yBTpJJVHACzVf"
          }
        },
        "updated-by": {
          "data": {
            "type": "memberships",
            "id": "C7xWERND6yBTpJJVHACzVf"
          }
        },
        "deleted-by": {
          "data": null
        }
      }
    }
  ]
}

Voice Template Revision ¶

This resource manages retrieving a specified voice template revision instance.

Retrieve Voice Template Revision
GET`/voice-templates/revisions/`

Retrieve an existing voice template revision instance.

Example URI

GET https://api.omnigage.io/api/v1/voice-templates/revisions/

Response 200

HideShow

Body

{
  "data": {
    "id": "RaF56o2r58hTKT7AYS9doj",
    "type": "voice-templates",
    "attributes": {
      "name": "Spring Specials",
      "kind": "audio",
      "status": "completed",
      "body": null,
      "is-archived": false,
      "created-at": "2020-01-01T00:00:00+00:00",
      "updated-at": "2020-01-01T00:00:00+00:00",
      "deleted-at": null
    },
    "relationships": {
      "file": {
        "data": {
          "type": "files",
          "id": "ZskVKR7C7WgdvytxeTSP3d"
        }
      },
      "tags": {
        "data": [
          {
            "type": "tags",
            "id": "WyUXyQqjyuz4UN5X7yAzW7"
          },
          {
            "type": "tags",
            "id": "vL7kCsN495rVZCLcJjUhXx"
          }
        ]
      },
      "primary": {
        "data": {
          "type": "voice-templates",
          "id": "RaF56o2r58hTKT7AYS9doj"
        }
      },
      "revision": {
        "data": {
          "type": "voice-templates",
          "id": "KR7C7WgdvytxeTSP3dZskV"
        }
      },
      "revisions": {
        "links": {
          "related": "voice-templates/RaF56o2r58hTKT7AYS9doj/revisions"
        }
      },
      "language": {
        "data": {
          "type": "languages",
          "id": "grSFiiqc3PK5Drkio9cZxx"
        }
      },
      "created-by": {
        "data": {
          "type": "memberships",
          "id": "C7xWERND6yBTpJJVHACzVf"
        }
      },
      "updated-by": {
        "data": {
          "type": "memberships",
          "id": "C7xWERND6yBTpJJVHACzVf"
        }
      },
      "deleted-by": {
        "data": null
      }
    }
  }
}

Voice Template Collaborator Collection ¶

This resource manages the retrieval of collaborator collections and the creation of collaborator instances.

Retrieve Voice Template Collaborators
GET`/voice-templates/collaborators{?include,sort,filter,page}`

Retrieve a collection of collaborators.

Example URI

GET https://api.omnigage.io/api/v1/voice-templates/collaborators?include=&sort=created-at&filter=1&page=10

URI Parameters

HideShow

include: string (optional)
Include one ore more related relationships using comma separated name.
sort: string (optional) Example: created-at
Sort on one or more fields using comma separated values.
filter: string (optional) Example: 1
Filter on one or more fields using comma separated values filter[field]=1,2.
page: string (optional) Example: 10
Use page[limit]=10 to reduce the number of instances returned. Use ?page[offset]=10 to skip this many instances.

Response 200

HideShow

Body

{
  "links": {
    "self": "/voice-templates/97iQjGNFLTZ5oxfYTKinwo/collaborators",
    "next": "/voice-templates/97iQjGNFLTZ5oxfYTKinwo/collaborators?page[offset]=10",
    "last": "/voice-templates/97iQjGNFLTZ5oxfYTKinwo/collaborators?page[offset]=100"
  },
  "meta": {
    "total": 1
  },
  "data": [
    {
      "id": "RaF56o2r58hTKT7AYS9doj",
      "type": "voice-templates-collaborators",
      "attributes": {
        "permission": "write",
        "is-archived": false,
        "created-at": "2020-01-01T00:00:00+00:00",
        "updated-at": "2020-01-01T00:00:00+00:00",
        "deleted-at": null
      },
      "relationships": {
        "membership": {
          "data": {
            "type": "memberships",
            "id": "6jVhCt5kE2p6e7B7SX9CGe"
          }
        },
        "team": {
          "data": null
        },
        "voice-template": {
          "data": {
            "type": "voice-templates",
            "id": "97iQjGNFLTZ5oxfYTKinwo"
          }
        },
        "created-by": {
          "data": {
            "type": "memberships",
            "id": "C7xWERND6yBTpJJVHACzVf"
          }
        },
        "updated-by": {
          "data": {
            "type": "memberships",
            "id": "C7xWERND6yBTpJJVHACzVf"
          }
        },
        "deleted-by": {
          "data": null
        }
      }
    }
  ]
}

Create Voice Template Collaborator
POST`/voice-templates/collaborators`

Create a new collaborator instance.

Example URI

POST https://api.omnigage.io/api/v1/voice-templates/collaborators

Request

HideShow

Body

{
  "data": {
    "type": "voice-templates-collaborators",
    "attributes": {
      "permission": "write"
    },
    "relationships": {
      "membership": {
        "data": {
          "type": "memberships",
          "id": "6jVhCt5kE2p6e7B7SX9CGe"
        }
      },
      "voice-template": {
        "data": {
          "type": "voice-templates",
          "id": "97iQjGNFLTZ5oxfYTKinwo"
        }
      }
    }
  }
}

Response 201

HideShow

Body

{
  "data": {
    "id": "RaF56o2r58hTKT7AYS9doj",
    "type": "voice-templates-collaborators",
    "attributes": {
      "permission": "write",
      "is-archived": false,
      "created-at": "2020-01-01T00:00:00+00:00",
      "updated-at": "2020-01-01T00:00:00+00:00",
      "deleted-at": null
    },
    "relationships": {
      "membership": {
        "data": {
          "type": "memberships",
          "id": "6jVhCt5kE2p6e7B7SX9CGe"
        }
      },
      "team": {
        "data": null
      },
      "voice-template": {
        "data": {
          "type": "voice-templates",
          "id": "97iQjGNFLTZ5oxfYTKinwo"
        }
      },
      "created-by": {
        "data": {
          "type": "memberships",
          "id": "C7xWERND6yBTpJJVHACzVf"
        }
      },
      "updated-by": {
        "data": {
          "type": "memberships",
          "id": "C7xWERND6yBTpJJVHACzVf"
        }
      },
      "deleted-by": {
        "data": null
      }
    }
  }
}

Voice Template Collaborator ¶

This resource manages updating and retrieving a specified collaborator instance.

Retrieve Voice Template Collaborator
GET`/voice-templates/collaborators/`

Retrieve an existing collaborator instance.

Example URI

GET https://api.omnigage.io/api/v1/voice-templates/collaborators/

Response 200

HideShow

Body

{
  "data": {
    "id": "RaF56o2r58hTKT7AYS9doj",
    "type": "voice-templates-collaborators",
    "attributes": {
      "permission": "write",
      "is-archived": false,
      "created-at": "2020-01-01T00:00:00+00:00",
      "updated-at": "2020-01-01T00:00:00+00:00",
      "deleted-at": null
    },
    "relationships": {
      "membership": {
        "data": {
          "type": "memberships",
          "id": "6jVhCt5kE2p6e7B7SX9CGe"
        }
      },
      "team": {
        "data": null
      },
      "voice-template": {
        "data": {
          "type": "voice-templates",
          "id": "97iQjGNFLTZ5oxfYTKinwo"
        }
      },
      "created-by": {
        "data": {
          "type": "memberships",
          "id": "C7xWERND6yBTpJJVHACzVf"
        }
      },
      "updated-by": {
        "data": {
          "type": "memberships",
          "id": "C7xWERND6yBTpJJVHACzVf"
        }
      },
      "deleted-by": {
        "data": null
      }
    }
  }
}

Update Voice Template Collaborator
PATCH`/voice-templates/collaborators/`

Update an existing collaborator instance.

Note: A membership cannot edit their own instance.

Example URI

PATCH https://api.omnigage.io/api/v1/voice-templates/collaborators/

Request

HideShow

Body

{
  "data": {
    "id": "RaF56o2r58hTKT7AYS9doj",
    "type": "voice-templates-collaborators",
    "attributes": {
      "permission": "write",
      "is-archived": false,
      "created-at": "2020-01-01T00:00:00+00:00",
      "updated-at": "2020-01-01T00:00:00+00:00",
      "deleted-at": null
    },
    "relationships": {
      "membership": {
        "data": {
          "type": "memberships",
          "id": "6jVhCt5kE2p6e7B7SX9CGe"
        }
      },
      "team": {
        "data": null
      },
      "voice-template": {
        "data": {
          "type": "voice-templates",
          "id": "97iQjGNFLTZ5oxfYTKinwo"
        }
      },
      "created-by": {
        "data": {
          "type": "memberships",
          "id": "C7xWERND6yBTpJJVHACzVf"
        }
      },
      "updated-by": {
        "data": {
          "type": "memberships",
          "id": "C7xWERND6yBTpJJVHACzVf"
        }
      },
      "deleted-by": {
        "data": null
      }
    }
  }
}

Response 202

HideShow

Body

{
  "data": {
    "id": "RaF56o2r58hTKT7AYS9doj",
    "type": "voice-templates-collaborators",
    "attributes": {
      "permission": "write",
      "is-archived": false,
      "created-at": "2020-01-01T00:00:00+00:00",
      "updated-at": "2020-01-01T00:00:00+00:00",
      "deleted-at": null
    },
    "relationships": {
      "membership": {
        "data": {
          "type": "memberships",
          "id": "6jVhCt5kE2p6e7B7SX9CGe"
        }
      },
      "team": {
        "data": null
      },
      "voice-template": {
        "data": {
          "type": "voice-templates",
          "id": "97iQjGNFLTZ5oxfYTKinwo"
        }
      },
      "created-by": {
        "data": {
          "type": "memberships",
          "id": "C7xWERND6yBTpJJVHACzVf"
        }
      },
      "updated-by": {
        "data": {
          "type": "memberships",
          "id": "C7xWERND6yBTpJJVHACzVf"
        }
      },
      "deleted-by": {
        "data": null
      }
    }
  }
}

Delete Voice Template Collaborator
DELETE`/voice-templates/collaborators/`

Sets the is-archived field’s value to true. Note: The actual instance is not deleted.

Note: A membership cannot delete their own instance.

Example URI

DELETE https://api.omnigage.io/api/v1/voice-templates/collaborators/

Response 204

Speech Synthesis ¶

Create Speech Synthesis
POST`/speech-synthesis`

Create a request to synthesize speech.

Example URI

POST https://api.omnigage.io/api/v1/speech-synthesis

Request

HideShow

Body

{
  "data": {
    "type": "speech-synthesis",
    "attributes": {
      "text": "Hello world.",
      "kind": "ssml",
      "output-format": "ogg-vorbis",
      "voice": "Polly-Mads"
    }
  }
}

Response 201

HideShow

Body

{
  "data": {
    "id": "P5MbYEhpgs2h6uJ3DFTfFt",
    "type": "speech-synthesis",
    "attributes": {
      "url": "https://api.omnigage.io/path/to/audio.ogg"
    }
  }
}

Email Resources ¶

Email Collection ¶

This resource manages the retrieval of email collections and the creation of email instances.

Note: Only instances relating to an email-id the membership has collaborator access to will be returned.

Retrieve Emails
GET`/emails{?include,filter,sort,page}`

Retrieve a collection of emails.

Example URI

GET https://api.omnigage.io/api/v1/emails?include=&filter=1&sort=created-at&page=10

URI Parameters

HideShow

include: string (optional)
Include one ore more related relationships using comma separated name.
sort: string (optional) Example: created-at
Sort on one or more fields using comma separated values.
filter: string (optional) Example: 1
Filter on one or more fields using comma separated values filter[field]=1,2.
page: string (optional) Example: 10
Use page[limit]=10 to reduce the number of instances returned. Use ?page[offset]=10 to skip this many instances.

Response 200

HideShow

Body

{
  "links": {
    "self": "/emails",
    "next": "/emails?page[offset]=10",
    "last": "/emails?page[offset]=100"
  },
  "meta": {
    "total": 10
  },
  "data": [
    {
      "id": "DJibkCtTD5vc3ALpqNhDXf",
      "type": "emails",
      "attributes": {
        "from": "team@bell-labs.com",
        "to": "alexander.bell@bell-labs.com",
        "cc": [],
        "bcc": [],
        "direction": "outbound",
        "status": "delivered",
        "meta": {},
        "callback": null,
        "created-at": "2020-01-01T00:00:00+00:00",
        "updated-at": "2020-01-01T00:00:00+00:00"
      },
      "relationships": {
        "email-message": {
          "data": {
            "type": "email-messages",
            "id": "y8rXbsFEFUmGcxGPTWEEqm"
          }
        },
        "email-id": {
          "data": {
            "type": "email-ids",
            "id": "hGsEBVSaGfTUfA8hyhFVfx"
          }
        },
        "contact": {
          "data": {
            "type": "contacts",
            "id": "BrZ28QqauagbmWGwgbs8p8"
          }
        },
        "envelope": {
          "data": {
            "type": "envelopes",
            "id": "PqXjs2nzENBWf29MHWR7tP"
          }
        },
        "result": {
          "data": {
            "type": "email-results",
            "id": "SYv626tNVtprEQmMJDdr6B"
          }
        },
        "created-by": {
          "data": {
            "type": "memberships",
            "id": "C7xWERND6yBTpJJVHACzVf"
          }
        },
        "updated-by": {
          "data": {
            "type": "memberships",
            "id": "C7xWERND6yBTpJJVHACzVf"
          }
        }
      }
    }
  ]
}

Create Email
POST`/emails`

Create a new email instance.

Example URI

POST https://api.omnigage.io/api/v1/emails

Request

HideShow

Body

{
  "data": {
    "type": "emails",
    "attributes": {
      "to": "alexander.bell@bell-labs.com"
    },
    "relationships": {
      "email-message": {
        "data": {
          "type": "email-messages",
          "id": "y8rXbsFEFUmGcxGPTWEEqm"
        }
      },
      "email-id": {
        "data": {
          "type": "email-ids",
          "id": "hGsEBVSaGfTUfA8hyhFVfx"
        }
      },
      "contact": {
        "data": {
          "type": "contacts",
          "id": "BrZ28QqauagbmWGwgbs8p8"
        }
      }
    }
  }
}

Response 201

HideShow

Body

{
  "data": {
    "id": "DJibkCtTD5vc3ALpqNhDXf",
    "type": "emails",
    "attributes": {
      "from": "team@bell-labs.com",
      "to": "alexander.bell@bell-labs.com",
      "cc": [],
      "bcc": [],
      "direction": "outbound",
      "status": "delivered",
      "meta": {},
      "callback": null,
      "created-at": "2020-01-01T00:00:00+00:00",
      "updated-at": "2020-01-01T00:00:00+00:00"
    },
    "relationships": {
      "email-message": {
        "data": {
          "type": "email-messages",
          "id": "y8rXbsFEFUmGcxGPTWEEqm"
        }
      },
      "email-id": {
        "data": {
          "type": "email-ids",
          "id": "hGsEBVSaGfTUfA8hyhFVfx"
        }
      },
      "contact": {
        "data": {
          "type": "contacts",
          "id": "BrZ28QqauagbmWGwgbs8p8"
        }
      },
      "envelope": {
        "data": {
          "type": "envelopes",
          "id": "PqXjs2nzENBWf29MHWR7tP"
        }
      },
      "result": {
        "data": {
          "type": "email-results",
          "id": "SYv626tNVtprEQmMJDdr6B"
        }
      },
      "created-by": {
        "data": {
          "type": "memberships",
          "id": "C7xWERND6yBTpJJVHACzVf"
        }
      },
      "updated-by": {
        "data": {
          "type": "memberships",
          "id": "C7xWERND6yBTpJJVHACzVf"
        }
      }
    }
  }
}

Email ¶

This resource manages updating and retrieving a specified email instance.

Retrieve Email
GET`/emails/`

Retrieve an existing email instance.

Example URI

GET https://api.omnigage.io/api/v1/emails/

Response 200

HideShow

Body

{
  "data": {
    "id": "DJibkCtTD5vc3ALpqNhDXf",
    "type": "emails",
    "attributes": {
      "from": "team@bell-labs.com",
      "to": "alexander.bell@bell-labs.com",
      "cc": [],
      "bcc": [],
      "direction": "outbound",
      "status": "delivered",
      "meta": {},
      "callback": null,
      "created-at": "2020-01-01T00:00:00+00:00",
      "updated-at": "2020-01-01T00:00:00+00:00"
    },
    "relationships": {
      "email-message": {
        "data": {
          "type": "email-messages",
          "id": "y8rXbsFEFUmGcxGPTWEEqm"
        }
      },
      "email-id": {
        "data": {
          "type": "email-ids",
          "id": "hGsEBVSaGfTUfA8hyhFVfx"
        }
      },
      "contact": {
        "data": {
          "type": "contacts",
          "id": "BrZ28QqauagbmWGwgbs8p8"
        }
      },
      "envelope": {
        "data": {
          "type": "envelopes",
          "id": "PqXjs2nzENBWf29MHWR7tP"
        }
      },
      "result": {
        "data": {
          "type": "email-results",
          "id": "SYv626tNVtprEQmMJDdr6B"
        }
      },
      "created-by": {
        "data": {
          "type": "memberships",
          "id": "C7xWERND6yBTpJJVHACzVf"
        }
      },
      "updated-by": {
        "data": {
          "type": "memberships",
          "id": "C7xWERND6yBTpJJVHACzVf"
        }
      }
    }
  }
}

Email Result Collection ¶

This resource manages the retrieval of email result collections.

Note: Must filter by either email or envelope. Results are limited based on the membership’s collaborator access to the email relationship (determined by email-ids) or envelope relationship (determined by engagements).

Retrieve Email Results
GET`/email-results{?filter,include,sort,page}`

Retrieve a collection of email results.

Example URI

GET https://api.omnigage.io/api/v1/email-results?filter=&include=&sort=created-at&page=10

URI Parameters

HideShow

filter: string (required)
Filter on one or more fields using comma separated values filter[email.id]=DJibkCtTD5vc3ALpqNhDXf.
include: string (optional)
Include one ore more related relationships using comma separated name.
sort: string (optional) Example: created-at
Sort on one or more fields using comma separated values.
page: string (optional) Example: 10
Use page[limit]=10 to reduce the number of instances returned. Use ?page[offset]=10 to skip this many instances.

Response 200

HideShow

Body

{
  "links": {
    "self": "/email-results?filter[email.id]=DJibkCtTD5vc3ALpqNhDXf",
    "next": "/email-results?filter[email.id]=DJibkCtTD5vc3ALpqNhDXf&page[offset]=10",
    "last": "/email-results?filter[email.id]=DJibkCtTD5vc3ALpqNhDXf&page[offset]=100"
  },
  "meta": {
    "total": 110
  },
  "data": [
    {
      "id": "RaF56o2r58hTKT7AYS9doj",
      "type": "email-results",
      "attributes": {
        "kind": "open",
        "bounce-type": null,
        "link": null,
        "ip-address": "1.1.1.1",
        "user-agent": "Mozilla/5.0 (iPhone; CPU iPhone OS 10_3_3 like Mac OS X) AppleWebKit/603.3.8 (KHTML, like Gecko) Mobile/14G60",
        "created-at": "2020-01-01T00:00:00+00:00",
        "updated-at": "2020-01-01T00:00:00+00:00"
      },
      "relationships": {
        "email": {
          "data": {
            "type": "emails",
            "id": "vytxeTZskVKR7C7WgdSP3d"
          }
        },
        "envelope": {
          "data": {
            "type": "envelopes",
            "id": "zmj59oHk2DxyEW7cmZJgyo"
          }
        },
        "trigger": {
          "data": {
            "type": "triggers",
            "id": "r58hTKT7AYS9dojRaF56o2"
          }
        },
        "transition": {
          "data": null
        }
      }
    }
  ]
}

Email Result ¶

This resource manages retrieving a specified email result instance.

Retrieve Email Result
GET`/email-results/`

Retrieve an existing email result instance.

Example URI

GET https://api.omnigage.io/api/v1/email-results/

Response 200

HideShow

Body

{
  "data": {
    "id": "RaF56o2r58hTKT7AYS9doj",
    "type": "email-results",
    "attributes": {
      "kind": "open",
      "bounce-type": null,
      "link": null,
      "ip-address": "1.1.1.1",
      "user-agent": "Mozilla/5.0 (iPhone; CPU iPhone OS 10_3_3 like Mac OS X) AppleWebKit/603.3.8 (KHTML, like Gecko) Mobile/14G60",
      "created-at": "2020-01-01T00:00:00+00:00",
      "updated-at": "2020-01-01T00:00:00+00:00"
    },
    "relationships": {
      "email": {
        "data": {
          "type": "emails",
          "id": "vytxeTZskVKR7C7WgdSP3d"
        }
      },
      "envelope": {
        "data": {
          "type": "envelopes",
          "id": "zmj59oHk2DxyEW7cmZJgyo"
        }
      },
      "trigger": {
        "data": {
          "type": "triggers",
          "id": "r58hTKT7AYS9dojRaF56o2"
        }
      },
      "transition": {
        "data": null
      }
    }
  }
}

Email Message Collection ¶

This resource manages the retrieval of email message collections and the creation of email message instances.

Note: Only messages relating to a contact the membership has collaborator access to will be returned.

Retrieve Email Messages
GET`/email-messages{?include,filter,sort,page}`

Retrieve a collection of email messages.

Example URI

GET https://api.omnigage.io/api/v1/email-messages?include=&filter=1&sort=created-at&page=10

URI Parameters

HideShow

include: string (optional)
Include one ore more related relationships using comma separated name.
sort: string (optional) Example: created-at
Sort on one or more fields using comma separated values.
filter: string (optional) Example: 1
Filter on one or more fields using comma separated values filter[field]=1,2.
page: string (optional) Example: 10
Use page[limit]=10 to reduce the number of instances returned. Use ?page[offset]=10 to skip this many instances.

Response 200

HideShow

Body

{
  "links": {
    "self": "/email-messages",
    "next": "/email-messages?page[offset]=10",
    "last": "/email-messages?page[offset]=100"
  },
  "meta": {
    "total": 10
  },
  "data": [
    {
      "id": "RaF56o2r58hTKT7AYS9doj",
      "type": "email-messages",
      "attributes": {
        "subject": "Weekly Specials",
        "is-draft": false,
        "created-at": "2020-01-01T00:00:00+00:00",
        "updated-at": "2020-01-01T00:00:00+00:00"
      },
      "relationships": {
        "contact": {
          "data": {
            "type": "contacts",
            "id": "aYuQTGkqYa39vwxESdo2c4"
          }
        },
        "uploads": {
          "data": []
        },
        "files": {
          "data": [
            {
              "type": "files",
              "id": "r58hTKT7AYS9dojRaF56o2"
            },
            {
              "type": "files",
              "id": "ZskVKR7C7WgdvytxeTSP3d"
            }
          ]
        },
        "email-template": {
          "data": null
        },
        "created-by": {
          "data": {
            "type": "memberships",
            "id": "C7xWERND6yBTpJJVHACzVf"
          }
        },
        "updated-by": {
          "data": {
            "type": "memberships",
            "id": "C7xWERND6yBTpJJVHACzVf"
          }
        }
      }
    }
  ]
}

Create Email Message
POST`/email-messages`

Create a new email message instance.

Example URI

POST https://api.omnigage.io/api/v1/email-messages

Request

HideShow

Body

{
  "data": {
    "type": "email-messages",
    "attributes": {
      "subject": "Weekly Specials",
      "body": "<strong>Supports HTML</strong>"
    },
    "relationships": {
      "contact": {
        "data": {
          "type": "contacts",
          "id": "aYuQTGkqYa39vwxESdo2c4"
        }
      },
      "uploads": {
        "data": [
          {
            "type": "uploads",
            "id": "RaF56o2r58hTKT7AYS9doj"
          },
          {
            "type": "uploads",
            "id": "vytxeTZskVKR7C7WgdSP3d"
          }
        ]
      }
    }
  }
}

Response 201

HideShow

Body

{
  "data": {
    "id": "RaF56o2r58hTKT7AYS9doj",
    "type": "email-messages",
    "attributes": {
      "subject": "Weekly Specials",
      "body": "Hello {{first-name}},<br /><br /><strong>Supports HTML</strong>{{unsubscribe-link}}",
      "is-draft": true,
      "created-at": "2020-01-01T00:00:00+00:00",
      "updated-at": "2020-01-01T00:00:00+00:00"
    },
    "relationships": {
      "contact": {
        "data": {
          "type": "contacts",
          "id": "aYuQTGkqYa39vwxESdo2c4"
        }
      },
      "uploads": {
        "data": []
      },
      "files": {
        "data": [
          {
            "type": "files",
            "id": "r58hTKT7AYS9dojRaF56o2"
          },
          {
            "type": "files",
            "id": "ZskVKR7C7WgdvytxeTSP3d"
          }
        ]
      },
      "email-template": {
        "data": null
      },
      "created-by": {
        "data": {
          "type": "memberships",
          "id": "C7xWERND6yBTpJJVHACzVf"
        }
      },
      "updated-by": {
        "data": {
          "type": "memberships",
          "id": "C7xWERND6yBTpJJVHACzVf"
        }
      }
    }
  }
}

Email Message ¶

This resource manages updating and retrieving a specified email message instance.

Retrieve Email Message
GET`/email-messages/`

Retrieve an existing email message instance.

Example URI

GET https://api.omnigage.io/api/v1/email-messages/

Response 200

HideShow

Body

{
  "data": {
    "id": "RaF56o2r58hTKT7AYS9doj",
    "type": "email-messages",
    "attributes": {
      "subject": "Weekly Specials",
      "body": "Hello {{first-name}},<br /><br /><strong>Supports HTML</strong>{{unsubscribe-link}}",
      "is-draft": true,
      "created-at": "2020-01-01T00:00:00+00:00",
      "updated-at": "2020-01-01T00:00:00+00:00"
    },
    "relationships": {
      "contact": {
        "data": {
          "type": "contacts",
          "id": "aYuQTGkqYa39vwxESdo2c4"
        }
      },
      "uploads": {
        "data": []
      },
      "files": {
        "data": [
          {
            "type": "files",
            "id": "r58hTKT7AYS9dojRaF56o2"
          },
          {
            "type": "files",
            "id": "ZskVKR7C7WgdvytxeTSP3d"
          }
        ]
      },
      "email-template": {
        "data": null
      },
      "created-by": {
        "data": {
          "type": "memberships",
          "id": "C7xWERND6yBTpJJVHACzVf"
        }
      },
      "updated-by": {
        "data": {
          "type": "memberships",
          "id": "C7xWERND6yBTpJJVHACzVf"
        }
      }
    }
  }
}

Update Email Message
PATCH`/email-messages/`

Update an existing email message instance.

Note: An email message can only be updated when the instance is a draft.

Example URI

PATCH https://api.omnigage.io/api/v1/email-messages/

Request

HideShow

Body

{
  "data": {
    "id": "RaF56o2r58hTKT7AYS9doj",
    "type": "email-messages",
    "attributes": {
      "subject": "Weekly Specials",
      "body": "Hello {{first-name}},<br /><br /><strong>Supports HTML</strong>{{unsubscribe-link}}",
      "is-draft": true,
      "created-at": "2020-01-01T00:00:00+00:00",
      "updated-at": "2020-01-01T00:00:00+00:00"
    },
    "relationships": {
      "contact": {
        "data": {
          "type": "contacts",
          "id": "aYuQTGkqYa39vwxESdo2c4"
        }
      },
      "uploads": {
        "data": []
      },
      "files": {
        "data": [
          {
            "type": "files",
            "id": "r58hTKT7AYS9dojRaF56o2"
          },
          {
            "type": "files",
            "id": "ZskVKR7C7WgdvytxeTSP3d"
          }
        ]
      },
      "email-template": {
        "data": null
      },
      "created-by": {
        "data": {
          "type": "memberships",
          "id": "C7xWERND6yBTpJJVHACzVf"
        }
      },
      "updated-by": {
        "data": {
          "type": "memberships",
          "id": "C7xWERND6yBTpJJVHACzVf"
        }
      }
    }
  }
}

Response 202

HideShow

Body

{
  "data": {
    "id": "RaF56o2r58hTKT7AYS9doj",
    "type": "email-messages",
    "attributes": {
      "subject": "Weekly Specials",
      "body": "Hello {{first-name}},<br /><br /><strong>Supports HTML</strong>{{unsubscribe-link}}",
      "is-draft": true,
      "created-at": "2020-01-01T00:00:00+00:00",
      "updated-at": "2020-01-01T00:00:00+00:00"
    },
    "relationships": {
      "contact": {
        "data": {
          "type": "contacts",
          "id": "aYuQTGkqYa39vwxESdo2c4"
        }
      },
      "uploads": {
        "data": []
      },
      "files": {
        "data": [
          {
            "type": "files",
            "id": "r58hTKT7AYS9dojRaF56o2"
          },
          {
            "type": "files",
            "id": "ZskVKR7C7WgdvytxeTSP3d"
          }
        ]
      },
      "email-template": {
        "data": null
      },
      "created-by": {
        "data": {
          "type": "memberships",
          "id": "C7xWERND6yBTpJJVHACzVf"
        }
      },
      "updated-by": {
        "data": {
          "type": "memberships",
          "id": "C7xWERND6yBTpJJVHACzVf"
        }
      }
    }
  }
}

Delete Email Message
DELETE`/email-messages/`

Note: Can only delete messages that are drafts.

Example URI

DELETE https://api.omnigage.io/api/v1/email-messages/

Response 204

Email Template Collection ¶

This resource manages the retrieval of email template collections and the creation of email template instances.

Retrieve Email Templates
GET`/email-templates{?include,filter,sort,page}`

Retrieve a collection of email templates.

Example URI

GET https://api.omnigage.io/api/v1/email-templates?include=&filter=1&sort=created-at&page=10

URI Parameters

HideShow

include: string (optional)
Include one ore more related relationships using comma separated name.
sort: string (optional) Example: created-at
Sort on one or more fields using comma separated values.
filter: string (optional) Example: 1
Filter on one or more fields using comma separated values filter[field]=1,2.
page: string (optional) Example: 10
Use page[limit]=10 to reduce the number of instances returned. Use ?page[offset]=10 to skip this many instances.

Response 200

HideShow

Body

{
  "links": {
    "self": "/email-templates",
    "next": "/email-templates?page[offset]=10",
    "last": "/email-templates?page[offset]=100"
  },
  "meta": {
    "total": 110
  },
  "data": [
    {
      "id": "RaF56o2r58hTKT7AYS9doj",
      "type": "email-templates",
      "attributes": {
        "subject": "Weekly Specials",
        "body": "Hello {{first-name}},<br /><br /><strong>Supports HTML</strong>{{unsubscribe-link}}",
        "is-archived": false,
        "created-at": "2020-01-01T00:00:00+00:00",
        "updated-at": "2020-01-01T00:00:00+00:00",
        "deleted-at": null
      },
      "relationships": {
        "upload-files": {
          "data": []
        },
        "upload-attachments": {
          "data": []
        },
        "files": {
          "data": [
            {
              "type": "files",
              "id": "r58hTKT7AYS9dojRaF56o2"
            },
            {
              "type": "files",
              "id": "ZskVKR7C7WgdvytxeTSP3d"
            }
          ]
        },
        "attachments": {
          "data": [
            {
              "type": "files",
              "id": "r58hTKT7AYS9dojRaF56o2"
            }
          ]
        },
        "tags": {
          "data": [
            {
              "type": "tags",
              "id": "WyUXyQqjyuz4UN5X7yAzW7"
            },
            {
              "type": "tags",
              "id": "vL7kCsN495rVZCLcJjUhXx"
            }
          ]
        },
        "primary": {
          "data": {
            "type": "email-templates",
            "id": "RaF56o2r58hTKT7AYS9doj"
          }
        },
        "revision": {
          "data": {
            "type": "email-templates",
            "id": "KR7C7WgdvytxeTSP3dZskV"
          }
        },
        "revisions": {
          "links": {
            "related": "email-templates/RaF56o2r58hTKT7AYS9doj/revisions"
          }
        },
        "created-by": {
          "data": {
            "type": "memberships",
            "id": "C7xWERND6yBTpJJVHACzVf"
          }
        },
        "updated-by": {
          "data": {
            "type": "memberships",
            "id": "C7xWERND6yBTpJJVHACzVf"
          }
        },
        "deleted-by": {
          "data": null
        }
      }
    }
  ]
}

Create Email Template
POST`/email-templates`

Create a new email template instance.

The body supports the following variables:

{{first-name}}: Alexander (string, optional)
{{last-name}}: Bell (string, optional)
{{title}}: Mr. (string, optional)
{{company}}: Bell Company (string, optional)
{{birthday}}: 1847-03-03 (string, optional) - ISO 8601 YYYY-MM-DD
{{gender}} (enum[string], optional)
- Members
  - female
  - male
{{unsubscribe-link}}: <a href="https://id.omnigage.io/unsubscribe/envelope/yy5nawE3bNhMzeZx9LkX6A/ACVNYwMH4cQayFIiGv43kyztCBwFzrEW3bj">Unsubscribe</a> (string, required)
{{unsubscribe-url}}: https://id.omnigage.io/unsubscribe/envelope/yy5nawE3bNhMzeZx9LkX6A/ACVNYwMH4cQayFIiGv43kyztCBwFzrEW3bj (string, required)

Note: If the email template is being used with engagements and the message does not have an unsubscribe URL, it will be appended to the body.

Example URI

POST https://api.omnigage.io/api/v1/email-templates

Request

HideShow

Body

{
  "data": {
    "type": "email-templates",
    "attributes": {
      "subject": "Weekly Specials",
      "body": "Hello {{first-name}},<br /><br /><strong>Supports HTML</strong>{{unsubscribe-link}}"
    },
    "relationships": {
      "upload-files": {
        "data": [
          {
            "type": "uploads",
            "id": "RaF56o2r58hTKT7AYS9doj"
          },
          {
            "type": "uploads",
            "id": "vytxeTZskVKR7C7WgdSP3d"
          }
        ]
      },
      "upload-attachments": {
        "data": [
          {
            "type": "uploads",
            "id": "TAdPLzcBwCKo4wP4oexM7L"
          }
        ]
      },
      "tags": {
        "data": [
          {
            "type": "tags",
            "id": "WyUXyQqjyuz4UN5X7yAzW7"
          },
          {
            "type": "tags",
            "id": "vL7kCsN495rVZCLcJjUhXx"
          }
        ]
      }
    }
  }
}

Response 201

HideShow

Body

{
  "data": {
    "id": "RaF56o2r58hTKT7AYS9doj",
    "type": "email-templates",
    "attributes": {
      "subject": "Weekly Specials",
      "body": "Hello {{first-name}},<br /><br /><strong>Supports HTML</strong>{{unsubscribe-link}}",
      "is-archived": false,
      "created-at": "2020-01-01T00:00:00+00:00",
      "updated-at": "2020-01-01T00:00:00+00:00",
      "deleted-at": null
    },
    "relationships": {
      "upload-files": {
        "data": []
      },
      "upload-attachments": {
        "data": []
      },
      "files": {
        "data": [
          {
            "type": "files",
            "id": "r58hTKT7AYS9dojRaF56o2"
          },
          {
            "type": "files",
            "id": "ZskVKR7C7WgdvytxeTSP3d"
          }
        ]
      },
      "attachments": {
        "data": [
          {
            "type": "files",
            "id": "r58hTKT7AYS9dojRaF56o2"
          }
        ]
      },
      "tags": {
        "data": [
          {
            "type": "tags",
            "id": "WyUXyQqjyuz4UN5X7yAzW7"
          },
          {
            "type": "tags",
            "id": "vL7kCsN495rVZCLcJjUhXx"
          }
        ]
      },
      "primary": {
        "data": {
          "type": "email-templates",
          "id": "RaF56o2r58hTKT7AYS9doj"
        }
      },
      "revision": {
        "data": {
          "type": "email-templates",
          "id": "KR7C7WgdvytxeTSP3dZskV"
        }
      },
      "revisions": {
        "links": {
          "related": "email-templates/RaF56o2r58hTKT7AYS9doj/revisions"
        }
      },
      "created-by": {
        "data": {
          "type": "memberships",
          "id": "C7xWERND6yBTpJJVHACzVf"
        }
      },
      "updated-by": {
        "data": {
          "type": "memberships",
          "id": "C7xWERND6yBTpJJVHACzVf"
        }
      },
      "deleted-by": {
        "data": null
      }
    }
  }
}

Email Template ¶

This resource manages updating and retrieving a specified email template instance.

Retrieve Email Template
GET`/email-templates/`

Retrieve an existing email template instance.

Example URI

GET https://api.omnigage.io/api/v1/email-templates/

Response 200

HideShow

Body

{
  "data": {
    "id": "RaF56o2r58hTKT7AYS9doj",
    "type": "email-templates",
    "attributes": {
      "subject": "Weekly Specials",
      "body": "Hello {{first-name}},<br /><br /><strong>Supports HTML</strong>{{unsubscribe-link}}",
      "is-archived": false,
      "created-at": "2020-01-01T00:00:00+00:00",
      "updated-at": "2020-01-01T00:00:00+00:00",
      "deleted-at": null
    },
    "relationships": {
      "upload-files": {
        "data": []
      },
      "upload-attachments": {
        "data": []
      },
      "files": {
        "data": [
          {
            "type": "files",
            "id": "r58hTKT7AYS9dojRaF56o2"
          },
          {
            "type": "files",
            "id": "ZskVKR7C7WgdvytxeTSP3d"
          }
        ]
      },
      "attachments": {
        "data": [
          {
            "type": "files",
            "id": "r58hTKT7AYS9dojRaF56o2"
          }
        ]
      },
      "tags": {
        "data": [
          {
            "type": "tags",
            "id": "WyUXyQqjyuz4UN5X7yAzW7"
          },
          {
            "type": "tags",
            "id": "vL7kCsN495rVZCLcJjUhXx"
          }
        ]
      },
      "primary": {
        "data": {
          "type": "email-templates",
          "id": "RaF56o2r58hTKT7AYS9doj"
        }
      },
      "revision": {
        "data": {
          "type": "email-templates",
          "id": "KR7C7WgdvytxeTSP3dZskV"
        }
      },
      "revisions": {
        "links": {
          "related": "email-templates/RaF56o2r58hTKT7AYS9doj/revisions"
        }
      },
      "created-by": {
        "data": {
          "type": "memberships",
          "id": "C7xWERND6yBTpJJVHACzVf"
        }
      },
      "updated-by": {
        "data": {
          "type": "memberships",
          "id": "C7xWERND6yBTpJJVHACzVf"
        }
      },
      "deleted-by": {
        "data": null
      }
    }
  }
}

Update Email Template
PATCH`/email-templates/`

Update an existing email template instance.

Note: Updating will create a new revision. This includes adding or archiving files.

Example URI

PATCH https://api.omnigage.io/api/v1/email-templates/

Request

HideShow

Body

{
  "data": {
    "id": "RaF56o2r58hTKT7AYS9doj",
    "type": "email-templates",
    "attributes": {
      "subject": "Weekly Specials",
      "body": "Hello {{first-name}},<br /><br /><strong>Supports HTML</strong>{{unsubscribe-link}}",
      "is-archived": false,
      "created-at": "2020-01-01T00:00:00+00:00",
      "updated-at": "2020-01-01T00:00:00+00:00",
      "deleted-at": null
    },
    "relationships": {
      "upload-files": {
        "data": []
      },
      "upload-attachments": {
        "data": []
      },
      "files": {
        "data": [
          {
            "type": "files",
            "id": "r58hTKT7AYS9dojRaF56o2"
          },
          {
            "type": "files",
            "id": "ZskVKR7C7WgdvytxeTSP3d"
          }
        ]
      },
      "attachments": {
        "data": [
          {
            "type": "files",
            "id": "r58hTKT7AYS9dojRaF56o2"
          }
        ]
      },
      "tags": {
        "data": [
          {
            "type": "tags",
            "id": "WyUXyQqjyuz4UN5X7yAzW7"
          },
          {
            "type": "tags",
            "id": "vL7kCsN495rVZCLcJjUhXx"
          }
        ]
      },
      "primary": {
        "data": {
          "type": "email-templates",
          "id": "RaF56o2r58hTKT7AYS9doj"
        }
      },
      "revision": {
        "data": {
          "type": "email-templates",
          "id": "KR7C7WgdvytxeTSP3dZskV"
        }
      },
      "revisions": {
        "links": {
          "related": "email-templates/RaF56o2r58hTKT7AYS9doj/revisions"
        }
      },
      "created-by": {
        "data": {
          "type": "memberships",
          "id": "C7xWERND6yBTpJJVHACzVf"
        }
      },
      "updated-by": {
        "data": {
          "type": "memberships",
          "id": "C7xWERND6yBTpJJVHACzVf"
        }
      },
      "deleted-by": {
        "data": null
      }
    }
  }
}

Response 202

HideShow

Body

{
  "data": {
    "id": "RaF56o2r58hTKT7AYS9doj",
    "type": "email-templates",
    "attributes": {
      "subject": "Weekly Specials",
      "body": "Hello {{first-name}},<br /><br /><strong>Supports HTML</strong>{{unsubscribe-link}}",
      "is-archived": false,
      "created-at": "2020-01-01T00:00:00+00:00",
      "updated-at": "2020-01-01T00:00:00+00:00",
      "deleted-at": null
    },
    "relationships": {
      "upload-files": {
        "data": []
      },
      "upload-attachments": {
        "data": []
      },
      "files": {
        "data": [
          {
            "type": "files",
            "id": "r58hTKT7AYS9dojRaF56o2"
          },
          {
            "type": "files",
            "id": "ZskVKR7C7WgdvytxeTSP3d"
          }
        ]
      },
      "attachments": {
        "data": [
          {
            "type": "files",
            "id": "r58hTKT7AYS9dojRaF56o2"
          }
        ]
      },
      "tags": {
        "data": [
          {
            "type": "tags",
            "id": "WyUXyQqjyuz4UN5X7yAzW7"
          },
          {
            "type": "tags",
            "id": "vL7kCsN495rVZCLcJjUhXx"
          }
        ]
      },
      "primary": {
        "data": {
          "type": "email-templates",
          "id": "RaF56o2r58hTKT7AYS9doj"
        }
      },
      "revision": {
        "data": {
          "type": "email-templates",
          "id": "KR7C7WgdvytxeTSP3dZskV"
        }
      },
      "revisions": {
        "links": {
          "related": "email-templates/RaF56o2r58hTKT7AYS9doj/revisions"
        }
      },
      "created-by": {
        "data": {
          "type": "memberships",
          "id": "C7xWERND6yBTpJJVHACzVf"
        }
      },
      "updated-by": {
        "data": {
          "type": "memberships",
          "id": "C7xWERND6yBTpJJVHACzVf"
        }
      },
      "deleted-by": {
        "data": null
      }
    }
  }
}

Delete Email Template
DELETE`/email-templates/`

Sets the is-archived field’s value to true. Note: The actual instance is not deleted.

Example URI

DELETE https://api.omnigage.io/api/v1/email-templates/

Response 204

Email Template Revision Collection ¶

This resource manages the retrieval of a given email template’s revisions.

Note: Revisions cannot be edited or deleted.

Retrieve Email Template Revisions
GET`/email-templates/revisions{?include,filter,sort,page}`

Retrieve a collection of email template revisions.

Example URI

GET https://api.omnigage.io/api/v1/email-templates/revisions?include=&filter=1&sort=created-at&page=10

URI Parameters

HideShow

include: string (optional)
Include one ore more related relationships using comma separated name.
sort: string (optional) Example: created-at
Sort on one or more fields using comma separated values.
filter: string (optional) Example: 1
Filter on one or more fields using comma separated values filter[field]=1,2.
page: string (optional) Example: 10
Use page[limit]=10 to reduce the number of instances returned. Use ?page[offset]=10 to skip this many instances.

Response 200

HideShow

Body

{
  "links": {
    "self": "/email-templates",
    "next": "/email-templates?page[offset]=10",
    "last": "/email-templates?page[offset]=100"
  },
  "meta": {
    "total": 110
  },
  "data": [
    {
      "id": "RaF56o2r58hTKT7AYS9doj",
      "type": "email-templates",
      "attributes": {
        "subject": "Weekly Specials",
        "body": "Hello {{first-name}},<br /><br /><strong>Supports HTML</strong>{{unsubscribe-link}}",
        "is-archived": false,
        "created-at": "2020-01-01T00:00:00+00:00",
        "updated-at": "2020-01-01T00:00:00+00:00",
        "deleted-at": null
      },
      "relationships": {
        "upload-files": {
          "data": []
        },
        "upload-attachments": {
          "data": []
        },
        "files": {
          "data": [
            {
              "type": "files",
              "id": "r58hTKT7AYS9dojRaF56o2"
            },
            {
              "type": "files",
              "id": "ZskVKR7C7WgdvytxeTSP3d"
            }
          ]
        },
        "attachments": {
          "data": [
            {
              "type": "files",
              "id": "r58hTKT7AYS9dojRaF56o2"
            }
          ]
        },
        "tags": {
          "data": [
            {
              "type": "tags",
              "id": "WyUXyQqjyuz4UN5X7yAzW7"
            },
            {
              "type": "tags",
              "id": "vL7kCsN495rVZCLcJjUhXx"
            }
          ]
        },
        "primary": {
          "data": {
            "type": "email-templates",
            "id": "RaF56o2r58hTKT7AYS9doj"
          }
        },
        "revision": {
          "data": {
            "type": "email-templates",
            "id": "KR7C7WgdvytxeTSP3dZskV"
          }
        },
        "revisions": {
          "links": {
            "related": "email-templates/RaF56o2r58hTKT7AYS9doj/revisions"
          }
        },
        "created-by": {
          "data": {
            "type": "memberships",
            "id": "C7xWERND6yBTpJJVHACzVf"
          }
        },
        "updated-by": {
          "data": {
            "type": "memberships",
            "id": "C7xWERND6yBTpJJVHACzVf"
          }
        },
        "deleted-by": {
          "data": null
        }
      }
    }
  ]
}

Email Template Revision ¶

This resource manages retrieving a specified email template revision instance.

Retrieve Email Template Revision
GET`/email-templates/revisions/`

Retrieve an existing email template revision instance.

Example URI

GET https://api.omnigage.io/api/v1/email-templates/revisions/

Response 200

HideShow

Body

{
  "data": {
    "id": "RaF56o2r58hTKT7AYS9doj",
    "type": "email-templates",
    "attributes": {
      "subject": "Weekly Specials",
      "body": "Hello {{first-name}},<br /><br /><strong>Supports HTML</strong>{{unsubscribe-link}}",
      "is-archived": false,
      "created-at": "2020-01-01T00:00:00+00:00",
      "updated-at": "2020-01-01T00:00:00+00:00",
      "deleted-at": null
    },
    "relationships": {
      "upload-files": {
        "data": []
      },
      "upload-attachments": {
        "data": []
      },
      "files": {
        "data": [
          {
            "type": "files",
            "id": "r58hTKT7AYS9dojRaF56o2"
          },
          {
            "type": "files",
            "id": "ZskVKR7C7WgdvytxeTSP3d"
          }
        ]
      },
      "attachments": {
        "data": [
          {
            "type": "files",
            "id": "r58hTKT7AYS9dojRaF56o2"
          }
        ]
      },
      "tags": {
        "data": [
          {
            "type": "tags",
            "id": "WyUXyQqjyuz4UN5X7yAzW7"
          },
          {
            "type": "tags",
            "id": "vL7kCsN495rVZCLcJjUhXx"
          }
        ]
      },
      "primary": {
        "data": {
          "type": "email-templates",
          "id": "RaF56o2r58hTKT7AYS9doj"
        }
      },
      "revision": {
        "data": {
          "type": "email-templates",
          "id": "KR7C7WgdvytxeTSP3dZskV"
        }
      },
      "revisions": {
        "links": {
          "related": "email-templates/RaF56o2r58hTKT7AYS9doj/revisions"
        }
      },
      "created-by": {
        "data": {
          "type": "memberships",
          "id": "C7xWERND6yBTpJJVHACzVf"
        }
      },
      "updated-by": {
        "data": {
          "type": "memberships",
          "id": "C7xWERND6yBTpJJVHACzVf"
        }
      },
      "deleted-by": {
        "data": null
      }
    }
  }
}

Email Template Collaborator Collection ¶

This resource manages the retrieval of collaborator collections and the creation of collaborator instances.

Retrieve Email Template Collaborators
GET`/email-templates/collaborators{?include,sort,filter,page}`

Retrieve a collection of collaborators.

Example URI

GET https://api.omnigage.io/api/v1/email-templates/collaborators?include=&sort=created-at&filter=1&page=10

URI Parameters

HideShow

include: string (optional)
Include one ore more related relationships using comma separated name.
sort: string (optional) Example: created-at
Sort on one or more fields using comma separated values.
filter: string (optional) Example: 1
Filter on one or more fields using comma separated values filter[field]=1,2.
page: string (optional) Example: 10
Use page[limit]=10 to reduce the number of instances returned. Use ?page[offset]=10 to skip this many instances.

Response 200

HideShow

Body

{
  "links": {
    "self": "/email-templates/97iQjGNFLTZ5oxfYTKinwo/collaborators",
    "next": "/email-templates/97iQjGNFLTZ5oxfYTKinwo/collaborators?page[offset]=10",
    "last": "/email-templates/97iQjGNFLTZ5oxfYTKinwo/collaborators?page[offset]=100"
  },
  "meta": {
    "total": 1
  },
  "data": [
    {
      "id": "RaF56o2r58hTKT7AYS9doj",
      "type": "email-templates-collaborators",
      "attributes": {
        "permission": "write",
        "is-archived": false,
        "created-at": "2020-01-01T00:00:00+00:00",
        "updated-at": "2020-01-01T00:00:00+00:00",
        "deleted-at": null
      },
      "relationships": {
        "membership": {
          "data": {
            "type": "memberships",
            "id": "6jVhCt5kE2p6e7B7SX9CGe"
          }
        },
        "team": {
          "data": null
        },
        "email-template": {
          "data": {
            "type": "email-templates",
            "id": "97iQjGNFLTZ5oxfYTKinwo"
          }
        },
        "created-by": {
          "data": {
            "type": "memberships",
            "id": "C7xWERND6yBTpJJVHACzVf"
          }
        },
        "updated-by": {
          "data": {
            "type": "memberships",
            "id": "C7xWERND6yBTpJJVHACzVf"
          }
        },
        "deleted-by": {
          "data": null
        }
      }
    }
  ]
}

Create Email Template Collaborator
POST`/email-templates/collaborators`

Create a new collaborator instance.

Example URI

POST https://api.omnigage.io/api/v1/email-templates/collaborators

Request

HideShow

Body

{
  "data": {
    "type": "email-templates-collaborators",
    "attributes": {
      "permission": "write"
    },
    "relationships": {
      "membership": {
        "data": {
          "type": "memberships",
          "id": "6jVhCt5kE2p6e7B7SX9CGe"
        }
      },
      "email-template": {
        "data": {
          "type": "email-templates",
          "id": "97iQjGNFLTZ5oxfYTKinwo"
        }
      }
    }
  }
}

Response 201

HideShow

Body

{
  "data": {
    "id": "RaF56o2r58hTKT7AYS9doj",
    "type": "email-templates-collaborators",
    "attributes": {
      "permission": "write",
      "is-archived": false,
      "created-at": "2020-01-01T00:00:00+00:00",
      "updated-at": "2020-01-01T00:00:00+00:00",
      "deleted-at": null
    },
    "relationships": {
      "membership": {
        "data": {
          "type": "memberships",
          "id": "6jVhCt5kE2p6e7B7SX9CGe"
        }
      },
      "team": {
        "data": null
      },
      "email-template": {
        "data": {
          "type": "email-templates",
          "id": "97iQjGNFLTZ5oxfYTKinwo"
        }
      },
      "created-by": {
        "data": {
          "type": "memberships",
          "id": "C7xWERND6yBTpJJVHACzVf"
        }
      },
      "updated-by": {
        "data": {
          "type": "memberships",
          "id": "C7xWERND6yBTpJJVHACzVf"
        }
      },
      "deleted-by": {
        "data": null
      }
    }
  }
}

Email Template Collaborator ¶

This resource manages updating and retrieving a specified collaborator instance.

Retrieve Email Template Collaborator
GET`/email-templates/collaborators/`

Retrieve an existing collaborator instance.

Example URI

GET https://api.omnigage.io/api/v1/email-templates/collaborators/

Response 200

HideShow

Body

{
  "data": {
    "id": "RaF56o2r58hTKT7AYS9doj",
    "type": "email-templates-collaborators",
    "attributes": {
      "permission": "write",
      "is-archived": false,
      "created-at": "2020-01-01T00:00:00+00:00",
      "updated-at": "2020-01-01T00:00:00+00:00",
      "deleted-at": null
    },
    "relationships": {
      "membership": {
        "data": {
          "type": "memberships",
          "id": "6jVhCt5kE2p6e7B7SX9CGe"
        }
      },
      "team": {
        "data": null
      },
      "email-template": {
        "data": {
          "type": "email-templates",
          "id": "97iQjGNFLTZ5oxfYTKinwo"
        }
      },
      "created-by": {
        "data": {
          "type": "memberships",
          "id": "C7xWERND6yBTpJJVHACzVf"
        }
      },
      "updated-by": {
        "data": {
          "type": "memberships",
          "id": "C7xWERND6yBTpJJVHACzVf"
        }
      },
      "deleted-by": {
        "data": null
      }
    }
  }
}

Update Email Template Collaborator
PATCH`/email-templates/collaborators/`

Update an existing collaborator instance.

Note: A membership cannot edit their own instance.

Example URI

PATCH https://api.omnigage.io/api/v1/email-templates/collaborators/

Request

HideShow

Body

{
  "data": {
    "id": "RaF56o2r58hTKT7AYS9doj",
    "type": "email-templates-collaborators",
    "attributes": {
      "permission": "write",
      "is-archived": false,
      "created-at": "2020-01-01T00:00:00+00:00",
      "updated-at": "2020-01-01T00:00:00+00:00",
      "deleted-at": null
    },
    "relationships": {
      "membership": {
        "data": {
          "type": "memberships",
          "id": "6jVhCt5kE2p6e7B7SX9CGe"
        }
      },
      "team": {
        "data": null
      },
      "email-template": {
        "data": {
          "type": "email-templates",
          "id": "97iQjGNFLTZ5oxfYTKinwo"
        }
      },
      "created-by": {
        "data": {
          "type": "memberships",
          "id": "C7xWERND6yBTpJJVHACzVf"
        }
      },
      "updated-by": {
        "data": {
          "type": "memberships",
          "id": "C7xWERND6yBTpJJVHACzVf"
        }
      },
      "deleted-by": {
        "data": null
      }
    }
  }
}

Response 202

HideShow

Body

{
  "data": {
    "id": "RaF56o2r58hTKT7AYS9doj",
    "type": "email-templates-collaborators",
    "attributes": {
      "permission": "write",
      "is-archived": false,
      "created-at": "2020-01-01T00:00:00+00:00",
      "updated-at": "2020-01-01T00:00:00+00:00",
      "deleted-at": null
    },
    "relationships": {
      "membership": {
        "data": {
          "type": "memberships",
          "id": "6jVhCt5kE2p6e7B7SX9CGe"
        }
      },
      "team": {
        "data": null
      },
      "email-template": {
        "data": {
          "type": "email-templates",
          "id": "97iQjGNFLTZ5oxfYTKinwo"
        }
      },
      "created-by": {
        "data": {
          "type": "memberships",
          "id": "C7xWERND6yBTpJJVHACzVf"
        }
      },
      "updated-by": {
        "data": {
          "type": "memberships",
          "id": "C7xWERND6yBTpJJVHACzVf"
        }
      },
      "deleted-by": {
        "data": null
      }
    }
  }
}

Delete Email Template Collaborator
DELETE`/email-templates/collaborators/`

Sets the is-archived field’s value to true. Note: The actual instance is not deleted.

Note: A membership cannot delete their own instance.

Example URI

DELETE https://api.omnigage.io/api/v1/email-templates/collaborators/

Response 204

Text Resources ¶

Text Collection ¶

This resource manages the retrieval of text collections and the creation of text instances.

Note: Only instances relating to a phone-number the membership has collaborator access to will be returned.

Retrieve Texts
GET`/texts{?include,filter,sort,page}`

Retrieve a collection of texts.

Example URI

GET https://api.omnigage.io/api/v1/texts?include=&filter=1&sort=created-at&page=10

URI Parameters

HideShow

include: string (optional)
Include one ore more related relationships using comma separated name.
sort: string (optional) Example: created-at
Sort on one or more fields using comma separated values.
filter: string (optional) Example: 1
Filter on one or more fields using comma separated values filter[field]=1,2.
page: string (optional) Example: 10
Use page[limit]=10 to reduce the number of instances returned. Use ?page[offset]=10 to skip this many instances.

Response 200

HideShow

Body

{
  "links": {
    "self": "/texts",
    "next": "/texts?page[offset]=10",
    "last": "/texts?page[offset]=100"
  },
  "meta": {
    "total": 10
  },
  "data": [
    {
      "id": "A9GYbBJP52yvCKSKNPsgVn",
      "type": "texts",
      "attributes": {
        "from": "+18775550100",
        "to": "+15197566220",
        "direction": "outbound",
        "status": "delivered",
        "meta": {},
        "callback": null,
        "created-at": "2020-01-01T00:00:00+00:00",
        "updated-at": "2020-01-01T00:00:00+00:00"
      },
      "relationships": {
        "phone-number": {
          "data": {
            "type": "phone-numbers",
            "id": "vhUWSZVAxVCCroZaXeHY9c"
          }
        },
        "text-message": {
          "data": {
            "type": "text-messages",
            "id": "p2sh4Cj7PJjjHKrDkkZbyK"
          }
        },
        "contact": {
          "data": {
            "type": "contacts",
            "id": "WA4c3kVdciT7tf2pQSnj2c"
          }
        },
        "envelope": {
          "data": {
            "type": "envelopes",
            "id": "KFMdWdA8xpBS4Qir6GJZmF"
          }
        },
        "result": {
          "data": {
            "type": "text-results",
            "id": "SYv626tNVtprEQmMJDdr6B"
          }
        },
        "created-by": {
          "data": {
            "type": "memberships",
            "id": "C7xWERND6yBTpJJVHACzVf"
          }
        },
        "updated-by": {
          "data": {
            "type": "memberships",
            "id": "C7xWERND6yBTpJJVHACzVf"
          }
        }
      }
    }
  ]
}

Create Text
POST`/texts`

Create a new text instance.

Example URI

POST https://api.omnigage.io/api/v1/texts

Request

HideShow

Body

{
  "data": {
    "type": "texts",
    "attributes": {
      "to": "+15197566220"
    },
    "relationships": {
      "phone-number": {
        "data": {
          "type": "phone-numbers",
          "id": "vhUWSZVAxVCCroZaXeHY9c"
        }
      },
      "text-message": {
        "data": {
          "type": "text-messages",
          "id": "p2sh4Cj7PJjjHKrDkkZbyK"
        }
      },
      "contact": {
        "data": {
          "type": "contacts",
          "id": "WA4c3kVdciT7tf2pQSnj2c"
        }
      }
    }
  }
}

Response 201

HideShow

Body

{
  "data": {
    "id": "A9GYbBJP52yvCKSKNPsgVn",
    "type": "texts",
    "attributes": {
      "from": "+18775550100",
      "to": "+15197566220",
      "direction": "outbound",
      "status": "delivered",
      "meta": {},
      "callback": null,
      "created-at": "2020-01-01T00:00:00+00:00",
      "updated-at": "2020-01-01T00:00:00+00:00"
    },
    "relationships": {
      "phone-number": {
        "data": {
          "type": "phone-numbers",
          "id": "vhUWSZVAxVCCroZaXeHY9c"
        }
      },
      "text-message": {
        "data": {
          "type": "text-messages",
          "id": "p2sh4Cj7PJjjHKrDkkZbyK"
        }
      },
      "contact": {
        "data": {
          "type": "contacts",
          "id": "WA4c3kVdciT7tf2pQSnj2c"
        }
      },
      "envelope": {
        "data": {
          "type": "envelopes",
          "id": "KFMdWdA8xpBS4Qir6GJZmF"
        }
      },
      "result": {
        "data": {
          "type": "text-results",
          "id": "SYv626tNVtprEQmMJDdr6B"
        }
      },
      "created-by": {
        "data": {
          "type": "memberships",
          "id": "C7xWERND6yBTpJJVHACzVf"
        }
      },
      "updated-by": {
        "data": {
          "type": "memberships",
          "id": "C7xWERND6yBTpJJVHACzVf"
        }
      }
    }
  }
}

Text ¶

This resource manages updating and retrieving a specified text instance.

Retrieve Text
GET`/texts/`

Retrieve an existing text instance.

Example URI

GET https://api.omnigage.io/api/v1/texts/

Response 200

HideShow

Body

{
  "data": {
    "id": "A9GYbBJP52yvCKSKNPsgVn",
    "type": "texts",
    "attributes": {
      "from": "+18775550100",
      "to": "+15197566220",
      "direction": "outbound",
      "status": "delivered",
      "meta": {},
      "callback": null,
      "created-at": "2020-01-01T00:00:00+00:00",
      "updated-at": "2020-01-01T00:00:00+00:00"
    },
    "relationships": {
      "phone-number": {
        "data": {
          "type": "phone-numbers",
          "id": "vhUWSZVAxVCCroZaXeHY9c"
        }
      },
      "text-message": {
        "data": {
          "type": "text-messages",
          "id": "p2sh4Cj7PJjjHKrDkkZbyK"
        }
      },
      "contact": {
        "data": {
          "type": "contacts",
          "id": "WA4c3kVdciT7tf2pQSnj2c"
        }
      },
      "envelope": {
        "data": {
          "type": "envelopes",
          "id": "KFMdWdA8xpBS4Qir6GJZmF"
        }
      },
      "result": {
        "data": {
          "type": "text-results",
          "id": "SYv626tNVtprEQmMJDdr6B"
        }
      },
      "created-by": {
        "data": {
          "type": "memberships",
          "id": "C7xWERND6yBTpJJVHACzVf"
        }
      },
      "updated-by": {
        "data": {
          "type": "memberships",
          "id": "C7xWERND6yBTpJJVHACzVf"
        }
      }
    }
  }
}

Text Result Collection ¶

This resource manages the retrieval of text result collections.

Note: Must filter by either text or envelope. Results are limited based on the membership’s collaborator access to the text relationship (determined by phone-numbers) or envelope relationship (determined by engagements).

Retrieve Text Results
GET`/text-results{?include,filter,sort,page}`

Retrieve a collection of text results.

Example URI

GET https://api.omnigage.io/api/v1/text-results?include=&filter=&sort=created-at&page=10

URI Parameters

HideShow

filter: string (required)
Filter on one or more fields using comma separated values filter[text.id]=DJibkCtTD5vc3ALpqNhDXf.
include: string (optional)
Include one ore more related relationships using comma separated name.
sort: string (optional) Example: created-at
Sort on one or more fields using comma separated values.
page: string (optional) Example: 10
Use page[limit]=10 to reduce the number of instances returned. Use ?page[offset]=10 to skip this many instances.

Response 200

HideShow

Body

{
  "links": {
    "self": "/text-results?filter[text.id]=DJibkCtTD5vc3ALpqNhDXf",
    "next": "/text-results?filter[text.id]=DJibkCtTD5vc3ALpqNhDXf&page[offset]=10",
    "last": "/text-results?filter[text.id]=DJibkCtTD5vc3ALpqNhDXf&page[offset]=100"
  },
  "meta": {
    "total": 110
  },
  "data": [
    {
      "id": "RaF56o2r58hTKT7AYS9doj",
      "type": "text-results",
      "attributes": {
        "kind": "delivered",
        "created-at": "2020-01-01T00:00:00+00:00",
        "updated-at": "2020-01-01T00:00:00+00:00"
      },
      "relationships": {
        "text": {
          "data": {
            "type": "texts",
            "id": "vytxeTZskVKR7C7WgdSP3d"
          }
        },
        "envelope": {
          "data": {
            "type": "envelopes",
            "id": "zmj59oHk2DxyEW7cmZJgyo"
          }
        },
        "trigger": {
          "data": {
            "type": "triggers",
            "id": "r58hTKT7AYS9dojRaF56o2"
          }
        },
        "transition": {
          "data": null
        }
      }
    }
  ]
}

Text Result ¶

This resource manages retrieving a specified text result instance.

Retrieve Text Result
GET`/text-results/`

Retrieve an existing text result instance.

Example URI

GET https://api.omnigage.io/api/v1/text-results/

Response 200

HideShow

Body

{
  "data": {
    "id": "RaF56o2r58hTKT7AYS9doj",
    "type": "text-results",
    "attributes": {
      "kind": "delivered",
      "created-at": "2020-01-01T00:00:00+00:00",
      "updated-at": "2020-01-01T00:00:00+00:00"
    },
    "relationships": {
      "text": {
        "data": {
          "type": "texts",
          "id": "vytxeTZskVKR7C7WgdSP3d"
        }
      },
      "envelope": {
        "data": {
          "type": "envelopes",
          "id": "zmj59oHk2DxyEW7cmZJgyo"
        }
      },
      "trigger": {
        "data": {
          "type": "triggers",
          "id": "r58hTKT7AYS9dojRaF56o2"
        }
      },
      "transition": {
        "data": null
      }
    }
  }
}

Text Message Collection ¶

This resource manages the retrieval of text message collections and the creation of text message instances.

Note: Only messages relating to a contact the membership has collaborator access to will be returned.

Retrieve Text Messages
GET`/text-messages{?include,filter,sort,page}`

Retrieve a collection of text messages.

Example URI

GET https://api.omnigage.io/api/v1/text-messages?include=&filter=1&sort=created-at&page=10

URI Parameters

HideShow

include: string (optional)
Include one ore more related relationships using comma separated name.
sort: string (optional) Example: created-at
Sort on one or more fields using comma separated values.
filter: string (optional) Example: 1
Filter on one or more fields using comma separated values filter[field]=1,2.
page: string (optional) Example: 10
Use page[limit]=10 to reduce the number of instances returned. Use ?page[offset]=10 to skip this many instances.

Response 200

HideShow

Body

{
  "links": {
    "self": "/text-messages",
    "next": "/text-messages?page[offset]=10",
    "last": "/text-messages?page[offset]=100"
  },
  "meta": {
    "total": 10
  },
  "data": [
    {
      "id": "RaF56o2r58hTKT7AYS9doj",
      "type": "text-messages",
      "attributes": {
        "is-draft": false,
        "created-at": "2020-01-01T00:00:00+00:00",
        "updated-at": "2020-01-01T00:00:00+00:00"
      },
      "relationships": {
        "contact": {
          "data": null
        },
        "uploads": {
          "data": []
        },
        "files": {
          "data": [
            {
              "type": "files",
              "id": "r58hTKT7AYS9dojRaF56o2"
            },
            {
              "type": "files",
              "id": "ZskVKR7C7WgdvytxeTSP3d"
            }
          ]
        },
        "text-template": {
          "data": null
        },
        "created-by": {
          "data": {
            "type": "memberships",
            "id": "C7xWERND6yBTpJJVHACzVf"
          }
        },
        "updated-by": {
          "data": {
            "type": "memberships",
            "id": "C7xWERND6yBTpJJVHACzVf"
          }
        }
      }
    }
  ]
}

Create Text Message
POST`/text-messages`

Create a new text message instance.

Example URI

POST https://api.omnigage.io/api/v1/text-messages

Request

HideShow

Body

{
  "data": {
    "type": "text-messages",
    "attributes": {
      "body": "Checkout these specials!"
    },
    "relationships": {
      "contact": {
        "data": {
          "type": "contacts",
          "id": "aYuQTGkqYa39vwxESdo2c4"
        }
      },
      "uploads": {
        "data": [
          {
            "type": "uploads",
            "id": "RaF56o2r58hTKT7AYS9doj"
          },
          {
            "type": "uploads",
            "id": "vytxeTZskVKR7C7WgdSP3d"
          }
        ]
      }
    }
  }
}

Response 201

HideShow

Body

{
  "data": {
    "id": "RaF56o2r58hTKT7AYS9doj",
    "type": "text-messages",
    "attributes": {
      "body": "Checkout these specials!",
      "is-draft": true,
      "created-at": "2020-01-01T00:00:00+00:00",
      "updated-at": "2020-01-01T00:00:00+00:00"
    },
    "relationships": {
      "contact": {
        "data": null
      },
      "uploads": {
        "data": []
      },
      "files": {
        "data": [
          {
            "type": "files",
            "id": "r58hTKT7AYS9dojRaF56o2"
          },
          {
            "type": "files",
            "id": "ZskVKR7C7WgdvytxeTSP3d"
          }
        ]
      },
      "text-template": {
        "data": null
      },
      "created-by": {
        "data": {
          "type": "memberships",
          "id": "C7xWERND6yBTpJJVHACzVf"
        }
      },
      "updated-by": {
        "data": {
          "type": "memberships",
          "id": "C7xWERND6yBTpJJVHACzVf"
        }
      }
    }
  }
}

Text Message ¶

This resource manages updating and retrieving a specified text message instance.

Retrieve Text Message
GET`/text-messages/`

Retrieve an existing text message instance.

Example URI

GET https://api.omnigage.io/api/v1/text-messages/

Response 200

HideShow

Body

{
  "data": {
    "id": "RaF56o2r58hTKT7AYS9doj",
    "type": "text-messages",
    "attributes": {
      "body": "Checkout these specials!",
      "is-draft": true,
      "created-at": "2020-01-01T00:00:00+00:00",
      "updated-at": "2020-01-01T00:00:00+00:00"
    },
    "relationships": {
      "contact": {
        "data": null
      },
      "uploads": {
        "data": []
      },
      "files": {
        "data": [
          {
            "type": "files",
            "id": "r58hTKT7AYS9dojRaF56o2"
          },
          {
            "type": "files",
            "id": "ZskVKR7C7WgdvytxeTSP3d"
          }
        ]
      },
      "text-template": {
        "data": null
      },
      "created-by": {
        "data": {
          "type": "memberships",
          "id": "C7xWERND6yBTpJJVHACzVf"
        }
      },
      "updated-by": {
        "data": {
          "type": "memberships",
          "id": "C7xWERND6yBTpJJVHACzVf"
        }
      }
    }
  }
}

Update Text Message
PATCH`/text-messages/`

Update an existing text message instance.

Note: An text message can only be updated when the instance is a draft.

Example URI

PATCH https://api.omnigage.io/api/v1/text-messages/

Request

HideShow

Body

{
  "data": {
    "id": "RaF56o2r58hTKT7AYS9doj",
    "type": "text-messages",
    "attributes": {
      "body": "Checkout these specials!",
      "is-draft": true,
      "created-at": "2020-01-01T00:00:00+00:00",
      "updated-at": "2020-01-01T00:00:00+00:00"
    },
    "relationships": {
      "contact": {
        "data": null
      },
      "uploads": {
        "data": []
      },
      "files": {
        "data": [
          {
            "type": "files",
            "id": "r58hTKT7AYS9dojRaF56o2"
          },
          {
            "type": "files",
            "id": "ZskVKR7C7WgdvytxeTSP3d"
          }
        ]
      },
      "text-template": {
        "data": null
      },
      "created-by": {
        "data": {
          "type": "memberships",
          "id": "C7xWERND6yBTpJJVHACzVf"
        }
      },
      "updated-by": {
        "data": {
          "type": "memberships",
          "id": "C7xWERND6yBTpJJVHACzVf"
        }
      }
    }
  }
}

Response 202

HideShow

Body

{
  "data": {
    "id": "RaF56o2r58hTKT7AYS9doj",
    "type": "text-messages",
    "attributes": {
      "body": "Checkout these specials!",
      "is-draft": true,
      "created-at": "2020-01-01T00:00:00+00:00",
      "updated-at": "2020-01-01T00:00:00+00:00"
    },
    "relationships": {
      "contact": {
        "data": null
      },
      "uploads": {
        "data": []
      },
      "files": {
        "data": [
          {
            "type": "files",
            "id": "r58hTKT7AYS9dojRaF56o2"
          },
          {
            "type": "files",
            "id": "ZskVKR7C7WgdvytxeTSP3d"
          }
        ]
      },
      "text-template": {
        "data": null
      },
      "created-by": {
        "data": {
          "type": "memberships",
          "id": "C7xWERND6yBTpJJVHACzVf"
        }
      },
      "updated-by": {
        "data": {
          "type": "memberships",
          "id": "C7xWERND6yBTpJJVHACzVf"
        }
      }
    }
  }
}

Delete Text Message
DELETE`/text-messages/`

Note: Can only delete messages that are drafts.

Example URI

DELETE https://api.omnigage.io/api/v1/text-messages/

Response 204

Text Template Collection ¶

This resource manages the retrieval of text template collections and the creation of text template instances.

Retrieve Text Templates
GET`/text-templates{?include,filter,sort,page}`

Retrieve a collection of text templates.

Example URI

GET https://api.omnigage.io/api/v1/text-templates?include=&filter=1&sort=created-at&page=10

URI Parameters

HideShow

include: string (optional)
Include one ore more related relationships using comma separated name.
sort: string (optional) Example: created-at
Sort on one or more fields using comma separated values.
filter: string (optional) Example: 1
Filter on one or more fields using comma separated values filter[field]=1,2.
page: string (optional) Example: 10
Use page[limit]=10 to reduce the number of instances returned. Use ?page[offset]=10 to skip this many instances.

Response 200

HideShow

Body

{
  "links": {
    "self": "/text-templates",
    "next": "/text-templates?page[offset]=10",
    "last": "/text-templates?page[offset]=100"
  },
  "meta": {
    "total": 110
  },
  "data": [
    {
      "id": "RaF56o2r58hTKT7AYS9doj",
      "type": "text-templates",
      "attributes": {
        "name": "Spring Specials",
        "is-archived": false,
        "created-at": "2020-01-01T00:00:00+00:00",
        "updated-at": "2020-01-01T00:00:00+00:00",
        "deleted-at": null
      },
      "relationships": {
        "files": {
          "data": [
            {
              "type": "files",
              "id": "r58hTKT7AYS9dojRaF56o2"
            },
            {
              "type": "files",
              "id": "ZskVKR7C7WgdvytxeTSP3d"
            }
          ]
        },
        "tags": {
          "data": [
            {
              "type": "tags",
              "id": "WyUXyQqjyuz4UN5X7yAzW7"
            },
            {
              "type": "tags",
              "id": "vL7kCsN495rVZCLcJjUhXx"
            }
          ]
        },
        "primary": {
          "data": {
            "type": "text-templates",
            "id": "RaF56o2r58hTKT7AYS9doj"
          }
        },
        "revision": {
          "data": {
            "type": "text-templates",
            "id": "KR7C7WgdvytxeTSP3dZskV"
          }
        },
        "revisions": {
          "links": {
            "related": "text-templates/RaF56o2r58hTKT7AYS9doj/revisions"
          }
        },
        "created-by": {
          "data": {
            "type": "memberships",
            "id": "C7xWERND6yBTpJJVHACzVf"
          }
        },
        "updated-by": {
          "data": {
            "type": "memberships",
            "id": "C7xWERND6yBTpJJVHACzVf"
          }
        },
        "deleted-by": {
          "data": null
        }
      }
    }
  ]
}

Create Text Template
POST`/text-templates`

Create a new text template instance.

The following file restrictions apply:

Only image content types are accepted such as image/jpeg, image/png, or image/gif.
Limit of 10 files are permitted.
Combined content size of all files must be less than 5 megabytes.

The body supports the following variables:

{{first-name}}: Alexander (string, optional)
{{last-name}}: Bell (string, optional)
{{title}}: Mr. (string, optional)
{{company}}: Bell Company (string, optional)
{{birthday}}: 1847-03-03 (string, optional) - ISO 8601 YYYY-MM-DD
{{gender}} (enum[string], optional)
- Members
  - female
  - male

Example URI

POST https://api.omnigage.io/api/v1/text-templates

Request

HideShow

Body

{
  "data": {
    "type": "text-templates",
    "attributes": {
      "name": "Spring Specials",
      "body": "Spring deals are here!"
    },
    "relationships": {
      "uploads": {
        "data": [
          {
            "type": "uploads",
            "id": "RaF56o2r58hTKT7AYS9doj"
          },
          {
            "type": "uploads",
            "id": "vytxeTZskVKR7C7WgdSP3d"
          }
        ]
      },
      "tags": {
        "data": [
          {
            "type": "tags",
            "id": "WyUXyQqjyuz4UN5X7yAzW7"
          },
          {
            "type": "tags",
            "id": "vL7kCsN495rVZCLcJjUhXx"
          }
        ]
      }
    }
  }
}

Response 201

HideShow

Body

{
  "data": {
    "id": "RaF56o2r58hTKT7AYS9doj",
    "type": "text-templates",
    "attributes": {
      "name": "Spring Specials",
      "body": "Spring deals are here!",
      "is-archived": false,
      "created-at": "2020-01-01T00:00:00+00:00",
      "updated-at": "2020-01-01T00:00:00+00:00",
      "deleted-at": null
    },
    "relationships": {
      "files": {
        "data": [
          {
            "type": "files",
            "id": "r58hTKT7AYS9dojRaF56o2"
          },
          {
            "type": "files",
            "id": "ZskVKR7C7WgdvytxeTSP3d"
          }
        ]
      },
      "tags": {
        "data": [
          {
            "type": "tags",
            "id": "WyUXyQqjyuz4UN5X7yAzW7"
          },
          {
            "type": "tags",
            "id": "vL7kCsN495rVZCLcJjUhXx"
          }
        ]
      },
      "primary": {
        "data": {
          "type": "text-templates",
          "id": "RaF56o2r58hTKT7AYS9doj"
        }
      },
      "revision": {
        "data": {
          "type": "text-templates",
          "id": "KR7C7WgdvytxeTSP3dZskV"
        }
      },
      "revisions": {
        "links": {
          "related": "text-templates/RaF56o2r58hTKT7AYS9doj/revisions"
        }
      },
      "created-by": {
        "data": {
          "type": "memberships",
          "id": "C7xWERND6yBTpJJVHACzVf"
        }
      },
      "updated-by": {
        "data": {
          "type": "memberships",
          "id": "C7xWERND6yBTpJJVHACzVf"
        }
      },
      "deleted-by": {
        "data": null
      }
    }
  }
}

Text Template ¶

This resource manages updating and retrieving a specified text template instance.

Retrieve Text Template
GET`/text-templates/`

Retrieve an existing text template instance.

Example URI

GET https://api.omnigage.io/api/v1/text-templates/

Response 200

HideShow

Body

{
  "data": {
    "id": "RaF56o2r58hTKT7AYS9doj",
    "type": "text-templates",
    "attributes": {
      "name": "Spring Specials",
      "body": "Spring deals are here!",
      "is-archived": false,
      "created-at": "2020-01-01T00:00:00+00:00",
      "updated-at": "2020-01-01T00:00:00+00:00",
      "deleted-at": null
    },
    "relationships": {
      "files": {
        "data": [
          {
            "type": "files",
            "id": "r58hTKT7AYS9dojRaF56o2"
          },
          {
            "type": "files",
            "id": "ZskVKR7C7WgdvytxeTSP3d"
          }
        ]
      },
      "tags": {
        "data": [
          {
            "type": "tags",
            "id": "WyUXyQqjyuz4UN5X7yAzW7"
          },
          {
            "type": "tags",
            "id": "vL7kCsN495rVZCLcJjUhXx"
          }
        ]
      },
      "primary": {
        "data": {
          "type": "text-templates",
          "id": "RaF56o2r58hTKT7AYS9doj"
        }
      },
      "revision": {
        "data": {
          "type": "text-templates",
          "id": "KR7C7WgdvytxeTSP3dZskV"
        }
      },
      "revisions": {
        "links": {
          "related": "text-templates/RaF56o2r58hTKT7AYS9doj/revisions"
        }
      },
      "created-by": {
        "data": {
          "type": "memberships",
          "id": "C7xWERND6yBTpJJVHACzVf"
        }
      },
      "updated-by": {
        "data": {
          "type": "memberships",
          "id": "C7xWERND6yBTpJJVHACzVf"
        }
      },
      "deleted-by": {
        "data": null
      }
    }
  }
}

Update Text Template
PATCH`/text-templates/`

Update an existing text-template instance.

Note: Updating will create a new revision. This includes adding or archiving files.

Example URI

PATCH https://api.omnigage.io/api/v1/text-templates/

Request

HideShow

Body

{
  "data": {
    "id": "RaF56o2r58hTKT7AYS9doj",
    "type": "text-templates",
    "attributes": {
      "name": "Spring Specials",
      "body": "Spring deals are here!",
      "is-archived": false,
      "created-at": "2020-01-01T00:00:00+00:00",
      "updated-at": "2020-01-01T00:00:00+00:00",
      "deleted-at": null
    },
    "relationships": {
      "files": {
        "data": [
          {
            "type": "files",
            "id": "r58hTKT7AYS9dojRaF56o2"
          },
          {
            "type": "files",
            "id": "ZskVKR7C7WgdvytxeTSP3d"
          }
        ]
      },
      "tags": {
        "data": [
          {
            "type": "tags",
            "id": "WyUXyQqjyuz4UN5X7yAzW7"
          },
          {
            "type": "tags",
            "id": "vL7kCsN495rVZCLcJjUhXx"
          }
        ]
      },
      "primary": {
        "data": {
          "type": "text-templates",
          "id": "RaF56o2r58hTKT7AYS9doj"
        }
      },
      "revision": {
        "data": {
          "type": "text-templates",
          "id": "KR7C7WgdvytxeTSP3dZskV"
        }
      },
      "revisions": {
        "links": {
          "related": "text-templates/RaF56o2r58hTKT7AYS9doj/revisions"
        }
      },
      "created-by": {
        "data": {
          "type": "memberships",
          "id": "C7xWERND6yBTpJJVHACzVf"
        }
      },
      "updated-by": {
        "data": {
          "type": "memberships",
          "id": "C7xWERND6yBTpJJVHACzVf"
        }
      },
      "deleted-by": {
        "data": null
      }
    }
  }
}

Response 202

HideShow

Body

{
  "data": {
    "id": "RaF56o2r58hTKT7AYS9doj",
    "type": "text-templates",
    "attributes": {
      "name": "Spring Specials",
      "body": "Spring deals are here!",
      "is-archived": false,
      "created-at": "2020-01-01T00:00:00+00:00",
      "updated-at": "2020-01-01T00:00:00+00:00",
      "deleted-at": null
    },
    "relationships": {
      "files": {
        "data": [
          {
            "type": "files",
            "id": "r58hTKT7AYS9dojRaF56o2"
          },
          {
            "type": "files",
            "id": "ZskVKR7C7WgdvytxeTSP3d"
          }
        ]
      },
      "tags": {
        "data": [
          {
            "type": "tags",
            "id": "WyUXyQqjyuz4UN5X7yAzW7"
          },
          {
            "type": "tags",
            "id": "vL7kCsN495rVZCLcJjUhXx"
          }
        ]
      },
      "primary": {
        "data": {
          "type": "text-templates",
          "id": "RaF56o2r58hTKT7AYS9doj"
        }
      },
      "revision": {
        "data": {
          "type": "text-templates",
          "id": "KR7C7WgdvytxeTSP3dZskV"
        }
      },
      "revisions": {
        "links": {
          "related": "text-templates/RaF56o2r58hTKT7AYS9doj/revisions"
        }
      },
      "created-by": {
        "data": {
          "type": "memberships",
          "id": "C7xWERND6yBTpJJVHACzVf"
        }
      },
      "updated-by": {
        "data": {
          "type": "memberships",
          "id": "C7xWERND6yBTpJJVHACzVf"
        }
      },
      "deleted-by": {
        "data": null
      }
    }
  }
}

Delete Text Template
DELETE`/text-templates/`

Sets the is-archived field’s value to true. Note: The actual instance is not deleted.

Example URI

DELETE https://api.omnigage.io/api/v1/text-templates/

Response 204

Text Template Revision Collection ¶

This resource manages the retrieval of a given text template’s revisions.

Note: Revisions cannot be edited or deleted.

Retrieve Text Template Revisions
GET`/text-templates/revisions{?include,filter,sort,page}`

Retrieve a collection of text template revisions.

Example URI

GET https://api.omnigage.io/api/v1/text-templates/revisions?include=&filter=1&sort=created-at&page=10

URI Parameters

HideShow

include: string (optional)
Include one ore more related relationships using comma separated name.
sort: string (optional) Example: created-at
Sort on one or more fields using comma separated values.
filter: string (optional) Example: 1
Filter on one or more fields using comma separated values filter[field]=1,2.
page: string (optional) Example: 10
Use page[limit]=10 to reduce the number of instances returned. Use ?page[offset]=10 to skip this many instances.

Response 200

HideShow

Body

{
  "links": {
    "self": "/text-templates",
    "next": "/text-templates?page[offset]=10",
    "last": "/text-templates?page[offset]=100"
  },
  "meta": {
    "total": 110
  },
  "data": [
    {
      "id": "RaF56o2r58hTKT7AYS9doj",
      "type": "text-templates",
      "attributes": {
        "name": "Spring Specials",
        "is-archived": false,
        "created-at": "2020-01-01T00:00:00+00:00",
        "updated-at": "2020-01-01T00:00:00+00:00",
        "deleted-at": null
      },
      "relationships": {
        "files": {
          "data": [
            {
              "type": "files",
              "id": "r58hTKT7AYS9dojRaF56o2"
            },
            {
              "type": "files",
              "id": "ZskVKR7C7WgdvytxeTSP3d"
            }
          ]
        },
        "tags": {
          "data": [
            {
              "type": "tags",
              "id": "WyUXyQqjyuz4UN5X7yAzW7"
            },
            {
              "type": "tags",
              "id": "vL7kCsN495rVZCLcJjUhXx"
            }
          ]
        },
        "primary": {
          "data": {
            "type": "text-templates",
            "id": "RaF56o2r58hTKT7AYS9doj"
          }
        },
        "revision": {
          "data": {
            "type": "text-templates",
            "id": "KR7C7WgdvytxeTSP3dZskV"
          }
        },
        "revisions": {
          "links": {
            "related": "text-templates/RaF56o2r58hTKT7AYS9doj/revisions"
          }
        },
        "created-by": {
          "data": {
            "type": "memberships",
            "id": "C7xWERND6yBTpJJVHACzVf"
          }
        },
        "updated-by": {
          "data": {
            "type": "memberships",
            "id": "C7xWERND6yBTpJJVHACzVf"
          }
        },
        "deleted-by": {
          "data": null
        }
      }
    }
  ]
}

Text Template Revision ¶

This resource manages retrieving a specified text template revision instance.

Retrieve Text Template Revision
GET`/text-templates/revisions/`

Retrieve an existing text template revision instance.

Example URI

GET https://api.omnigage.io/api/v1/text-templates/revisions/

Response 200

HideShow

Body

{
  "data": {
    "id": "RaF56o2r58hTKT7AYS9doj",
    "type": "text-templates",
    "attributes": {
      "name": "Spring Specials",
      "body": "Spring deals are here!",
      "is-archived": false,
      "created-at": "2020-01-01T00:00:00+00:00",
      "updated-at": "2020-01-01T00:00:00+00:00",
      "deleted-at": null
    },
    "relationships": {
      "files": {
        "data": [
          {
            "type": "files",
            "id": "r58hTKT7AYS9dojRaF56o2"
          },
          {
            "type": "files",
            "id": "ZskVKR7C7WgdvytxeTSP3d"
          }
        ]
      },
      "tags": {
        "data": [
          {
            "type": "tags",
            "id": "WyUXyQqjyuz4UN5X7yAzW7"
          },
          {
            "type": "tags",
            "id": "vL7kCsN495rVZCLcJjUhXx"
          }
        ]
      },
      "primary": {
        "data": {
          "type": "text-templates",
          "id": "RaF56o2r58hTKT7AYS9doj"
        }
      },
      "revision": {
        "data": {
          "type": "text-templates",
          "id": "KR7C7WgdvytxeTSP3dZskV"
        }
      },
      "revisions": {
        "links": {
          "related": "text-templates/RaF56o2r58hTKT7AYS9doj/revisions"
        }
      },
      "created-by": {
        "data": {
          "type": "memberships",
          "id": "C7xWERND6yBTpJJVHACzVf"
        }
      },
      "updated-by": {
        "data": {
          "type": "memberships",
          "id": "C7xWERND6yBTpJJVHACzVf"
        }
      },
      "deleted-by": {
        "data": null
      }
    }
  }
}

Text Template Collaborator Collection ¶

This resource manages the retrieval of collaborator collections and the creation of collaborator instances.

Retrieve Text Template Collaborators
GET`/text-templates/collaborators{?include,sort,filter,page}`

Retrieve a collection of collaborators.

Example URI

GET https://api.omnigage.io/api/v1/text-templates/collaborators?include=&sort=created-at&filter=1&page=10

URI Parameters

HideShow

include: string (optional)
Include one ore more related relationships using comma separated name.
sort: string (optional) Example: created-at
Sort on one or more fields using comma separated values.
filter: string (optional) Example: 1
Filter on one or more fields using comma separated values filter[field]=1,2.
page: string (optional) Example: 10
Use page[limit]=10 to reduce the number of instances returned. Use ?page[offset]=10 to skip this many instances.

Response 200

HideShow

Body

{
  "links": {
    "self": "/text-templates/97iQjGNFLTZ5oxfYTKinwo/collaborators",
    "next": "/text-templates/97iQjGNFLTZ5oxfYTKinwo/collaborators?page[offset]=10",
    "last": "/text-templates/97iQjGNFLTZ5oxfYTKinwo/collaborators?page[offset]=100"
  },
  "meta": {
    "total": 1
  },
  "data": [
    {
      "id": "RaF56o2r58hTKT7AYS9doj",
      "type": "text-templates-collaborators",
      "attributes": {
        "permission": "write",
        "is-archived": false,
        "created-at": "2020-01-01T00:00:00+00:00",
        "updated-at": "2020-01-01T00:00:00+00:00",
        "deleted-at": null
      },
      "relationships": {
        "membership": {
          "data": {
            "type": "memberships",
            "id": "6jVhCt5kE2p6e7B7SX9CGe"
          }
        },
        "team": {
          "data": null
        },
        "text-template": {
          "data": {
            "type": "text-templates",
            "id": "97iQjGNFLTZ5oxfYTKinwo"
          }
        },
        "created-by": {
          "data": {
            "type": "memberships",
            "id": "C7xWERND6yBTpJJVHACzVf"
          }
        },
        "updated-by": {
          "data": {
            "type": "memberships",
            "id": "C7xWERND6yBTpJJVHACzVf"
          }
        },
        "deleted-by": {
          "data": null
        }
      }
    }
  ]
}

Create Text Template Collaborator
POST`/text-templates/collaborators`

Create a new collaborator instance.

Example URI

POST https://api.omnigage.io/api/v1/text-templates/collaborators

Request

HideShow

Body

{
  "data": {
    "type": "text-templates-collaborators",
    "attributes": {
      "permission": "write"
    },
    "relationships": {
      "membership": {
        "data": {
          "type": "memberships",
          "id": "6jVhCt5kE2p6e7B7SX9CGe"
        }
      },
      "text-template": {
        "data": {
          "type": "text-templates",
          "id": "97iQjGNFLTZ5oxfYTKinwo"
        }
      }
    }
  }
}

Response 201

HideShow

Body

{
  "data": {
    "id": "RaF56o2r58hTKT7AYS9doj",
    "type": "text-templates-collaborators",
    "attributes": {
      "permission": "write",
      "is-archived": false,
      "created-at": "2020-01-01T00:00:00+00:00",
      "updated-at": "2020-01-01T00:00:00+00:00",
      "deleted-at": null
    },
    "relationships": {
      "membership": {
        "data": {
          "type": "memberships",
          "id": "6jVhCt5kE2p6e7B7SX9CGe"
        }
      },
      "team": {
        "data": null
      },
      "text-template": {
        "data": {
          "type": "text-templates",
          "id": "97iQjGNFLTZ5oxfYTKinwo"
        }
      },
      "created-by": {
        "data": {
          "type": "memberships",
          "id": "C7xWERND6yBTpJJVHACzVf"
        }
      },
      "updated-by": {
        "data": {
          "type": "memberships",
          "id": "C7xWERND6yBTpJJVHACzVf"
        }
      },
      "deleted-by": {
        "data": null
      }
    }
  }
}

Text Template Collaborator ¶

This resource manages updating and retrieving a specified collaborator instance.

Retrieve Text Template Collaborator
GET`/text-templates/collaborators/`

Retrieve an existing collaborator instance.

Example URI

GET https://api.omnigage.io/api/v1/text-templates/collaborators/

Response 200

HideShow

Body

{
  "data": {
    "id": "RaF56o2r58hTKT7AYS9doj",
    "type": "text-templates-collaborators",
    "attributes": {
      "permission": "write",
      "is-archived": false,
      "created-at": "2020-01-01T00:00:00+00:00",
      "updated-at": "2020-01-01T00:00:00+00:00",
      "deleted-at": null
    },
    "relationships": {
      "membership": {
        "data": {
          "type": "memberships",
          "id": "6jVhCt5kE2p6e7B7SX9CGe"
        }
      },
      "team": {
        "data": null
      },
      "text-template": {
        "data": {
          "type": "text-templates",
          "id": "97iQjGNFLTZ5oxfYTKinwo"
        }
      },
      "created-by": {
        "data": {
          "type": "memberships",
          "id": "C7xWERND6yBTpJJVHACzVf"
        }
      },
      "updated-by": {
        "data": {
          "type": "memberships",
          "id": "C7xWERND6yBTpJJVHACzVf"
        }
      },
      "deleted-by": {
        "data": null
      }
    }
  }
}

Update Text Template Collaborator
PATCH`/text-templates/collaborators/`

Update an existing collaborator instance.

Note: A membership cannot edit their own instance.

Example URI

PATCH https://api.omnigage.io/api/v1/text-templates/collaborators/

Request

HideShow

Body

{
  "data": {
    "id": "RaF56o2r58hTKT7AYS9doj",
    "type": "text-templates-collaborators",
    "attributes": {
      "permission": "write",
      "is-archived": false,
      "created-at": "2020-01-01T00:00:00+00:00",
      "updated-at": "2020-01-01T00:00:00+00:00",
      "deleted-at": null
    },
    "relationships": {
      "membership": {
        "data": {
          "type": "memberships",
          "id": "6jVhCt5kE2p6e7B7SX9CGe"
        }
      },
      "team": {
        "data": null
      },
      "text-template": {
        "data": {
          "type": "text-templates",
          "id": "97iQjGNFLTZ5oxfYTKinwo"
        }
      },
      "created-by": {
        "data": {
          "type": "memberships",
          "id": "C7xWERND6yBTpJJVHACzVf"
        }
      },
      "updated-by": {
        "data": {
          "type": "memberships",
          "id": "C7xWERND6yBTpJJVHACzVf"
        }
      },
      "deleted-by": {
        "data": null
      }
    }
  }
}

Response 202

HideShow

Body

{
  "data": {
    "id": "RaF56o2r58hTKT7AYS9doj",
    "type": "text-templates-collaborators",
    "attributes": {
      "permission": "write",
      "is-archived": false,
      "created-at": "2020-01-01T00:00:00+00:00",
      "updated-at": "2020-01-01T00:00:00+00:00",
      "deleted-at": null
    },
    "relationships": {
      "membership": {
        "data": {
          "type": "memberships",
          "id": "6jVhCt5kE2p6e7B7SX9CGe"
        }
      },
      "team": {
        "data": null
      },
      "text-template": {
        "data": {
          "type": "text-templates",
          "id": "97iQjGNFLTZ5oxfYTKinwo"
        }
      },
      "created-by": {
        "data": {
          "type": "memberships",
          "id": "C7xWERND6yBTpJJVHACzVf"
        }
      },
      "updated-by": {
        "data": {
          "type": "memberships",
          "id": "C7xWERND6yBTpJJVHACzVf"
        }
      },
      "deleted-by": {
        "data": null
      }
    }
  }
}

Delete Text Template Collaborator
DELETE`/text-templates/collaborators/`

Sets the is-archived field’s value to true. Note: The actual instance is not deleted.

Note: A membership cannot delete their own instance.

Example URI

DELETE https://api.omnigage.io/api/v1/text-templates/collaborators/

Response 204

Contacts Resources ¶

Contact Collection ¶

This resource manages the retrieval of contact collections and the creation of contact instances.

Retrieve Contacts
GET`/contacts{?include,filter,sort,page,list}`

Retrieve a collection of contacts.

Note: A contact can be retrieved based on the membership’s collaborator access to the contact. A contact can also be retrieved when a membership has collaborator access to a list for which the contact resides within.

Example URI

GET https://api.omnigage.io/api/v1/contacts?include=&filter=1&sort=created-at&page=10&list=RaF56o2r58hTKT7AYS9doj

URI Parameters

HideShow

include: string (optional)
Include one ore more related relationships using comma separated name.
sort: string (optional) Example: created-at
Sort on one or more fields using comma separated values.
filter: string (optional) Example: 1
Filter on one or more fields using comma separated values filter[field]=1,2.
page: string (optional) Example: 10
Use page[limit]=10 to reduce the number of instances returned. Use ?page[offset]=10 to skip this many instances.
list: string (optional) Example: RaF56o2r58hTKT7AYS9doj
Filter contacts by list

Response 200

HideShow

Body

{
  "links": {
    "self": "/contacts",
    "next": "/contacts?page[offset]=10",
    "last": "/contacts?page[offset]=100"
  },
  "meta": {
    "total": 110
  },
  "data": [
    {
      "id": "RaF56o2r58hTKT7AYS9doj",
      "type": "contacts",
      "attributes": {
        "company": "Bell Telephone Company",
        "title": "Mr.",
        "first-name": "Alexander",
        "last-name": "Bell",
        "birthday": "1847-03-03",
        "gender": "male",
        "status": "enabled",
        "is-archived": false,
        "created-at": "2020-01-01T00:00:00+00:00",
        "updated-at": "2020-01-01T00:00:00+00:00",
        "deleted-at": null
      },
      "relationships": {
        "primary-address": {
          "data": {
            "type": "contacts-addresses",
            "id": "vytxeTZskVKR7C7WgdSP3d"
          }
        },
        "primary-email": {
          "data": {
            "type": "contacts-emails",
            "id": "c8sh5y9hdSMS6zVnrvf53T"
          }
        },
        "primary-phone": {
          "data": {
            "type": "contacts-phones",
            "id": "wpsWLdLt9nscn2jbTD3uxe"
          }
        },
        "timezone": {
          "data": {
            "type": "timezones",
            "id": "TZskVKR7C7WgdSP3dvytxe"
          }
        },
        "addresses": {
          "links": {
            "related": "/contacts/RaF56o2r58hTKT7AYS9doj/addresses"
          },
          "data": [
            {
              "type": "contacts-addresses",
              "id": "vytxeTZskVKR7C7WgdSP3d"
            }
          ]
        },
        "emails": {
          "links": {
            "related": "/contacts/RaF56o2r58hTKT7AYS9doj/emails"
          },
          "data": [
            {
              "type": "contacts-emails",
              "id": "c8sh5y9hdSMS6zVnrvf53T"
            }
          ]
        },
        "phones": {
          "links": {
            "related": "/contacts/RaF56o2r58hTKT7AYS9doj/phones"
          },
          "data": [
            {
              "type": "contacts-phones",
              "id": "wpsWLdLt9nscn2jbTD3uxe"
            }
          ]
        },
        "identity": {
          "data": {
            "type": "users",
            "id": "hdSMS6zVnrvf53Tc8sh5y9"
          }
        },
        "created-by": {
          "data": {
            "type": "memberships",
            "id": "C7xWERND6yBTpJJVHACzVf"
          }
        },
        "updated-by": {
          "data": {
            "type": "memberships",
            "id": "C7xWERND6yBTpJJVHACzVf"
          }
        },
        "deleted-by": {
          "data": null
        }
      }
    }
  ]
}

Create Contact
POST`/contacts`

Create a new contact instance.

Example URI

POST https://api.omnigage.io/api/v1/contacts

Request

HideShow

Body

{
  "data": {
    "type": "contacts",
    "attributes": {
      "title": "Mr.",
      "first-name": "Alexander",
      "last-name": "Bell",
      "birthday": "1847-03-03",
      "gender": "male"
    },
    "relationships": {
      "timezone": {
        "data": {
          "type": "timezones",
          "id": "vytxeTZskVKR7C7WgdSP3d"
        }
      }
    }
  }
}

Response 201

HideShow

Body

{
  "data": {
    "id": "RaF56o2r58hTKT7AYS9doj",
    "type": "contacts",
    "attributes": {
      "company": "Bell Telephone Company",
      "title": "Mr.",
      "first-name": "Alexander",
      "last-name": "Bell",
      "birthday": "1847-03-03",
      "gender": "male",
      "status": "enabled",
      "is-archived": false,
      "created-at": "2020-01-01T00:00:00+00:00",
      "updated-at": "2020-01-01T00:00:00+00:00",
      "deleted-at": null
    },
    "relationships": {
      "primary-address": {
        "data": {
          "type": "contacts-addresses",
          "id": "vytxeTZskVKR7C7WgdSP3d"
        }
      },
      "primary-email": {
        "data": {
          "type": "contacts-emails",
          "id": "c8sh5y9hdSMS6zVnrvf53T"
        }
      },
      "primary-phone": {
        "data": {
          "type": "contacts-phones",
          "id": "wpsWLdLt9nscn2jbTD3uxe"
        }
      },
      "timezone": {
        "data": {
          "type": "timezones",
          "id": "TZskVKR7C7WgdSP3dvytxe"
        }
      },
      "addresses": {
        "links": {
          "related": "/contacts/RaF56o2r58hTKT7AYS9doj/addresses"
        },
        "data": [
          {
            "type": "contacts-addresses",
            "id": "vytxeTZskVKR7C7WgdSP3d"
          }
        ]
      },
      "emails": {
        "links": {
          "related": "/contacts/RaF56o2r58hTKT7AYS9doj/emails"
        },
        "data": [
          {
            "type": "contacts-emails",
            "id": "c8sh5y9hdSMS6zVnrvf53T"
          }
        ]
      },
      "phones": {
        "links": {
          "related": "/contacts/RaF56o2r58hTKT7AYS9doj/phones"
        },
        "data": [
          {
            "type": "contacts-phones",
            "id": "wpsWLdLt9nscn2jbTD3uxe"
          }
        ]
      },
      "identity": {
        "data": {
          "type": "users",
          "id": "hdSMS6zVnrvf53Tc8sh5y9"
        }
      },
      "created-by": {
        "data": {
          "type": "memberships",
          "id": "C7xWERND6yBTpJJVHACzVf"
        }
      },
      "updated-by": {
        "data": {
          "type": "memberships",
          "id": "C7xWERND6yBTpJJVHACzVf"
        }
      },
      "deleted-by": {
        "data": null
      }
    }
  }
}

Contact ¶

This resource manages updating and retrieving a specified contact instance.

Retrieve Contact
GET`/contacts/`

Retrieve an existing contact instance.

Example URI

GET https://api.omnigage.io/api/v1/contacts/

Request Contact

HideShow

Schema

{
  "$schema": "http://json-schema.org/draft-04/schema#"
}

Response 200

HideShow

Body

{
  "data": {
    "id": "RaF56o2r58hTKT7AYS9doj",
    "type": "contacts",
    "attributes": {
      "company": "Bell Telephone Company",
      "title": "Mr.",
      "first-name": "Alexander",
      "last-name": "Bell",
      "birthday": "1847-03-03",
      "gender": "male",
      "status": "enabled",
      "is-archived": false,
      "created-at": "2020-01-01T00:00:00+00:00",
      "updated-at": "2020-01-01T00:00:00+00:00",
      "deleted-at": null
    },
    "relationships": {
      "primary-address": {
        "data": {
          "type": "contacts-addresses",
          "id": "vytxeTZskVKR7C7WgdSP3d"
        }
      },
      "primary-email": {
        "data": {
          "type": "contacts-emails",
          "id": "c8sh5y9hdSMS6zVnrvf53T"
        }
      },
      "primary-phone": {
        "data": {
          "type": "contacts-phones",
          "id": "wpsWLdLt9nscn2jbTD3uxe"
        }
      },
      "timezone": {
        "data": {
          "type": "timezones",
          "id": "TZskVKR7C7WgdSP3dvytxe"
        }
      },
      "addresses": {
        "links": {
          "related": "/contacts/RaF56o2r58hTKT7AYS9doj/addresses"
        },
        "data": [
          {
            "type": "contacts-addresses",
            "id": "vytxeTZskVKR7C7WgdSP3d"
          }
        ]
      },
      "emails": {
        "links": {
          "related": "/contacts/RaF56o2r58hTKT7AYS9doj/emails"
        },
        "data": [
          {
            "type": "contacts-emails",
            "id": "c8sh5y9hdSMS6zVnrvf53T"
          }
        ]
      },
      "phones": {
        "links": {
          "related": "/contacts/RaF56o2r58hTKT7AYS9doj/phones"
        },
        "data": [
          {
            "type": "contacts-phones",
            "id": "wpsWLdLt9nscn2jbTD3uxe"
          }
        ]
      },
      "identity": {
        "data": {
          "type": "users",
          "id": "hdSMS6zVnrvf53Tc8sh5y9"
        }
      },
      "created-by": {
        "data": {
          "type": "memberships",
          "id": "C7xWERND6yBTpJJVHACzVf"
        }
      },
      "updated-by": {
        "data": {
          "type": "memberships",
          "id": "C7xWERND6yBTpJJVHACzVf"
        }
      },
      "deleted-by": {
        "data": null
      }
    }
  }
}

Update Contact
PATCH`/contacts/`

Update an existing contact instance.

Note: Authenticated membership must have collaborator write or admin privileges to edit the contact.

Example URI

PATCH https://api.omnigage.io/api/v1/contacts/

Request

HideShow

Body

{
  "data": {
    "id": "RaF56o2r58hTKT7AYS9doj",
    "type": "contacts",
    "attributes": {
      "company": "Bell Telephone Company",
      "title": "Mr.",
      "first-name": "Alexander",
      "last-name": "Bell",
      "birthday": "1847-03-03",
      "gender": "male",
      "status": "enabled",
      "is-archived": false,
      "created-at": "2020-01-01T00:00:00+00:00",
      "updated-at": "2020-01-01T00:00:00+00:00",
      "deleted-at": null
    },
    "relationships": {
      "primary-address": {
        "data": {
          "type": "contacts-addresses",
          "id": "vytxeTZskVKR7C7WgdSP3d"
        }
      },
      "primary-email": {
        "data": {
          "type": "contacts-emails",
          "id": "c8sh5y9hdSMS6zVnrvf53T"
        }
      },
      "primary-phone": {
        "data": {
          "type": "contacts-phones",
          "id": "wpsWLdLt9nscn2jbTD3uxe"
        }
      },
      "timezone": {
        "data": {
          "type": "timezones",
          "id": "TZskVKR7C7WgdSP3dvytxe"
        }
      },
      "addresses": {
        "links": {
          "related": "/contacts/RaF56o2r58hTKT7AYS9doj/addresses"
        },
        "data": [
          {
            "type": "contacts-addresses",
            "id": "vytxeTZskVKR7C7WgdSP3d"
          }
        ]
      },
      "emails": {
        "links": {
          "related": "/contacts/RaF56o2r58hTKT7AYS9doj/emails"
        },
        "data": [
          {
            "type": "contacts-emails",
            "id": "c8sh5y9hdSMS6zVnrvf53T"
          }
        ]
      },
      "phones": {
        "links": {
          "related": "/contacts/RaF56o2r58hTKT7AYS9doj/phones"
        },
        "data": [
          {
            "type": "contacts-phones",
            "id": "wpsWLdLt9nscn2jbTD3uxe"
          }
        ]
      },
      "identity": {
        "data": {
          "type": "users",
          "id": "hdSMS6zVnrvf53Tc8sh5y9"
        }
      },
      "created-by": {
        "data": {
          "type": "memberships",
          "id": "C7xWERND6yBTpJJVHACzVf"
        }
      },
      "updated-by": {
        "data": {
          "type": "memberships",
          "id": "C7xWERND6yBTpJJVHACzVf"
        }
      },
      "deleted-by": {
        "data": null
      }
    }
  }
}

Response 202

HideShow

Body

{
  "data": {
    "id": "RaF56o2r58hTKT7AYS9doj",
    "type": "contacts",
    "attributes": {
      "company": "Bell Telephone Company",
      "title": "Mr.",
      "first-name": "Alexander",
      "last-name": "Bell",
      "birthday": "1847-03-03",
      "gender": "male",
      "status": "enabled",
      "is-archived": false,
      "created-at": "2020-01-01T00:00:00+00:00",
      "updated-at": "2020-01-01T00:00:00+00:00",
      "deleted-at": null
    },
    "relationships": {
      "primary-address": {
        "data": {
          "type": "contacts-addresses",
          "id": "vytxeTZskVKR7C7WgdSP3d"
        }
      },
      "primary-email": {
        "data": {
          "type": "contacts-emails",
          "id": "c8sh5y9hdSMS6zVnrvf53T"
        }
      },
      "primary-phone": {
        "data": {
          "type": "contacts-phones",
          "id": "wpsWLdLt9nscn2jbTD3uxe"
        }
      },
      "timezone": {
        "data": {
          "type": "timezones",
          "id": "TZskVKR7C7WgdSP3dvytxe"
        }
      },
      "addresses": {
        "links": {
          "related": "/contacts/RaF56o2r58hTKT7AYS9doj/addresses"
        },
        "data": [
          {
            "type": "contacts-addresses",
            "id": "vytxeTZskVKR7C7WgdSP3d"
          }
        ]
      },
      "emails": {
        "links": {
          "related": "/contacts/RaF56o2r58hTKT7AYS9doj/emails"
        },
        "data": [
          {
            "type": "contacts-emails",
            "id": "c8sh5y9hdSMS6zVnrvf53T"
          }
        ]
      },
      "phones": {
        "links": {
          "related": "/contacts/RaF56o2r58hTKT7AYS9doj/phones"
        },
        "data": [
          {
            "type": "contacts-phones",
            "id": "wpsWLdLt9nscn2jbTD3uxe"
          }
        ]
      },
      "identity": {
        "data": {
          "type": "users",
          "id": "hdSMS6zVnrvf53Tc8sh5y9"
        }
      },
      "created-by": {
        "data": {
          "type": "memberships",
          "id": "C7xWERND6yBTpJJVHACzVf"
        }
      },
      "updated-by": {
        "data": {
          "type": "memberships",
          "id": "C7xWERND6yBTpJJVHACzVf"
        }
      },
      "deleted-by": {
        "data": null
      }
    }
  }
}

Delete Contact
DELETE`/contacts/`

Sets the is-archived field’s value to true. Note: The actual instance is not deleted.

Note: Authenticated membership must have collaborator write or admin privileges to delete the contact.

Example URI

DELETE https://api.omnigage.io/api/v1/contacts/

Response 204

Contact Address Collection ¶

This resource manages the retrieval of contact address collections and the creation of address instances.

Retrieve Contact Addresses
GET`/contacts/addresses{?include,filter,sort,page}`

Retrieve a collection of contact addresses.

Example URI

GET https://api.omnigage.io/api/v1/contacts/addresses?include=&filter=1&sort=created-at&page=10

URI Parameters

HideShow

include: string (optional)
Include one ore more related relationships using comma separated name.
sort: string (optional) Example: created-at
Sort on one or more fields using comma separated values.
filter: string (optional) Example: 1
Filter on one or more fields using comma separated values filter[field]=1,2.
page: string (optional) Example: 10
Use page[limit]=10 to reduce the number of instances returned. Use ?page[offset]=10 to skip this many instances.

Response 200

HideShow

Body

{
  "links": {
    "self": "/contacts/vytxeTZskVKR7C7WgdSP3d/addresses",
    "next": "/contacts/vytxeTZskVKR7C7WgdSP3d/addresses?page[offset]=10",
    "last": "/contacts/vytxeTZskVKR7C7WgdSP3d/addresses?page[offset]=100"
  },
  "meta": {
    "total": 110
  },
  "data": [
    {
      "id": "RaF56o2r58hTKT7AYS9doj",
      "type": "contacts-addresses",
      "attributes": {
        "label": "Address 1",
        "address1": "94 Tutela Heights Road",
        "address2": null,
        "city": "Brantford",
        "state": "Ontario",
        "zip": "N3P 1A1",
        "is-primary": true,
        "is-archived": false,
        "created-at": "2020-01-01T00:00:00+00:00",
        "updated-at": "2020-01-01T00:00:00+00:00",
        "deleted-at": null
      },
      "relationships": {
        "contact": {
          "data": {
            "type": "contacts",
            "id": "vytxeTZskVKR7C7WgdSP3d"
          }
        },
        "country": {
          "data": {
            "type": "countries",
            "id": "US"
          }
        },
        "created-by": {
          "data": {
            "type": "memberships",
            "id": "C7xWERND6yBTpJJVHACzVf"
          }
        },
        "updated-by": {
          "data": {
            "type": "memberships",
            "id": "C7xWERND6yBTpJJVHACzVf"
          }
        },
        "deleted-by": {
          "data": null
        }
      }
    }
  ]
}

Create Contact Address
POST`/contacts/addresses`

Create a new contact instance.

Example URI

POST https://api.omnigage.io/api/v1/contacts/addresses

Request

HideShow

Body

{
  "data": {
    "type": "contacts-addresses",
    "attributes": {
      "label": "Address 1",
      "address1": "94 Tutela Heights Road",
      "address2": null,
      "city": "Brantford",
      "state": "Ontario",
      "zip": "N3P 1A1"
    },
    "relationships": {
      "contact": {
        "data": {
          "type": "contacts",
          "id": "vytxeTZskVKR7C7WgdSP3d"
        }
      },
      "country": {
        "data": {
          "type": "countries",
          "id": "US"
        }
      }
    }
  }
}

Response 201

HideShow

Body

{
  "data": {
    "id": "RaF56o2r58hTKT7AYS9doj",
    "type": "contacts-addresses",
    "attributes": {
      "label": "Address 1",
      "address1": "94 Tutela Heights Road",
      "address2": null,
      "city": "Brantford",
      "state": "Ontario",
      "zip": "N3P 1A1",
      "is-primary": true,
      "is-archived": false,
      "created-at": "2020-01-01T00:00:00+00:00",
      "updated-at": "2020-01-01T00:00:00+00:00",
      "deleted-at": null
    },
    "relationships": {
      "contact": {
        "data": {
          "type": "contacts",
          "id": "vytxeTZskVKR7C7WgdSP3d"
        }
      },
      "country": {
        "data": {
          "type": "countries",
          "id": "US"
        }
      },
      "created-by": {
        "data": {
          "type": "memberships",
          "id": "C7xWERND6yBTpJJVHACzVf"
        }
      },
      "updated-by": {
        "data": {
          "type": "memberships",
          "id": "C7xWERND6yBTpJJVHACzVf"
        }
      },
      "deleted-by": {
        "data": null
      }
    }
  }
}

Contact Address ¶

This resource manages updating and retrieving a specified contact address instance.

Retrieve Contact Address
GET`/contacts/addresses/`

Retrieve an existing contact address instance.

Example URI

GET https://api.omnigage.io/api/v1/contacts/addresses/

Response 200

HideShow

Body

{
  "data": {
    "id": "RaF56o2r58hTKT7AYS9doj",
    "type": "contacts-addresses",
    "attributes": {
      "label": "Address 1",
      "address1": "94 Tutela Heights Road",
      "address2": null,
      "city": "Brantford",
      "state": "Ontario",
      "zip": "N3P 1A1",
      "is-primary": true,
      "is-archived": false,
      "created-at": "2020-01-01T00:00:00+00:00",
      "updated-at": "2020-01-01T00:00:00+00:00",
      "deleted-at": null
    },
    "relationships": {
      "contact": {
        "data": {
          "type": "contacts",
          "id": "vytxeTZskVKR7C7WgdSP3d"
        }
      },
      "country": {
        "data": {
          "type": "countries",
          "id": "US"
        }
      },
      "created-by": {
        "data": {
          "type": "memberships",
          "id": "C7xWERND6yBTpJJVHACzVf"
        }
      },
      "updated-by": {
        "data": {
          "type": "memberships",
          "id": "C7xWERND6yBTpJJVHACzVf"
        }
      },
      "deleted-by": {
        "data": null
      }
    }
  }
}

Update Contact Address
PATCH`/contacts/addresses/`

Update an existing contact address instance.

Example URI

PATCH https://api.omnigage.io/api/v1/contacts/addresses/

Request

HideShow

Body

{
  "data": {
    "id": "RaF56o2r58hTKT7AYS9doj",
    "type": "contacts-addresses",
    "attributes": {
      "label": "Address 1",
      "address1": "94 Tutela Heights Road",
      "address2": null,
      "city": "Brantford",
      "state": "Ontario",
      "zip": "N3P 1A1",
      "is-primary": true,
      "is-archived": false,
      "created-at": "2020-01-01T00:00:00+00:00",
      "updated-at": "2020-01-01T00:00:00+00:00",
      "deleted-at": null
    },
    "relationships": {
      "contact": {
        "data": {
          "type": "contacts",
          "id": "vytxeTZskVKR7C7WgdSP3d"
        }
      },
      "country": {
        "data": {
          "type": "countries",
          "id": "US"
        }
      },
      "created-by": {
        "data": {
          "type": "memberships",
          "id": "C7xWERND6yBTpJJVHACzVf"
        }
      },
      "updated-by": {
        "data": {
          "type": "memberships",
          "id": "C7xWERND6yBTpJJVHACzVf"
        }
      },
      "deleted-by": {
        "data": null
      }
    }
  }
}

Response 202

HideShow

Body

{
  "data": {
    "id": "RaF56o2r58hTKT7AYS9doj",
    "type": "contacts-addresses",
    "attributes": {
      "label": "Address 1",
      "address1": "94 Tutela Heights Road",
      "address2": null,
      "city": "Brantford",
      "state": "Ontario",
      "zip": "N3P 1A1",
      "is-primary": true,
      "is-archived": false,
      "created-at": "2020-01-01T00:00:00+00:00",
      "updated-at": "2020-01-01T00:00:00+00:00",
      "deleted-at": null
    },
    "relationships": {
      "contact": {
        "data": {
          "type": "contacts",
          "id": "vytxeTZskVKR7C7WgdSP3d"
        }
      },
      "country": {
        "data": {
          "type": "countries",
          "id": "US"
        }
      },
      "created-by": {
        "data": {
          "type": "memberships",
          "id": "C7xWERND6yBTpJJVHACzVf"
        }
      },
      "updated-by": {
        "data": {
          "type": "memberships",
          "id": "C7xWERND6yBTpJJVHACzVf"
        }
      },
      "deleted-by": {
        "data": null
      }
    }
  }
}

Delete Contact Address
DELETE`/contacts/addresses/`

Sets the is-archived field’s value to true. Note: The actual instance is not deleted.

Example URI

DELETE https://api.omnigage.io/api/v1/contacts/addresses/

Response 204

Contact Phone Collection ¶

This resource manages the retrieval of contact phone collections and the creation of phone instances.

Retrieve Contact Phones
GET`/contacts/phones{?include,filter,sort,page}`

Retrieve a collection of contact phones.

Example URI

GET https://api.omnigage.io/api/v1/contacts/phones?include=&filter=1&sort=created-at&page=10

URI Parameters

HideShow

include: string (optional)
Include one ore more related relationships using comma separated name.
sort: string (optional) Example: created-at
Sort on one or more fields using comma separated values.
filter: string (optional) Example: 1
Filter on one or more fields using comma separated values filter[field]=1,2.
page: string (optional) Example: 10
Use page[limit]=10 to reduce the number of instances returned. Use ?page[offset]=10 to skip this many instances.

Response 200

HideShow

Body

{
  "links": {
    "self": "/contacts/vytxeTZskVKR7C7WgdSP3d/phones",
    "next": "/contacts/vytxeTZskVKR7C7WgdSP3d/phones?page[offset]=10",
    "last": "/contacts/vytxeTZskVKR7C7WgdSP3d/phones?page[offset]=100"
  },
  "meta": {
    "total": 110
  },
  "data": [
    {
      "id": "RaF56o2r58hTKT7AYS9doj",
      "type": "contacts-phones",
      "attributes": {
        "label": "Phone 1",
        "phone-number": "+15197566220",
        "is-primary": true,
        "is-archived": false,
        "created-at": "2020-01-01T00:00:00+00:00",
        "updated-at": "2020-01-01T00:00:00+00:00",
        "deleted-at": null
      },
      "relationships": {
        "contact": {
          "data": {
            "type": "contacts",
            "id": "vytxeTZskVKR7C7WgdSP3d"
          }
        },
        "created-by": {
          "data": {
            "type": "memberships",
            "id": "C7xWERND6yBTpJJVHACzVf"
          }
        },
        "updated-by": {
          "data": {
            "type": "memberships",
            "id": "C7xWERND6yBTpJJVHACzVf"
          }
        },
        "deleted-by": {
          "data": null
        }
      }
    }
  ]
}

Create Contact Phone
POST`/contacts/phones`

Create a new contact instance.

Example URI

POST https://api.omnigage.io/api/v1/contacts/phones

Request

HideShow

Body

{
  "data": {
    "type": "contacts-phones",
    "attributes": {
      "label": "Phone 1",
      "phone-number": "+15197566220"
    },
    "relationships": {
      "contact": {
        "data": {
          "type": "contacts",
          "id": "vytxeTZskVKR7C7WgdSP3d"
        }
      }
    }
  }
}

Response 201

HideShow

Body

{
  "data": {
    "id": "RaF56o2r58hTKT7AYS9doj",
    "type": "contacts-phones",
    "attributes": {
      "label": "Phone 1",
      "phone-number": "+15197566220",
      "is-primary": true,
      "is-archived": false,
      "created-at": "2020-01-01T00:00:00+00:00",
      "updated-at": "2020-01-01T00:00:00+00:00",
      "deleted-at": null
    },
    "relationships": {
      "contact": {
        "data": {
          "type": "contacts",
          "id": "vytxeTZskVKR7C7WgdSP3d"
        }
      },
      "created-by": {
        "data": {
          "type": "memberships",
          "id": "C7xWERND6yBTpJJVHACzVf"
        }
      },
      "updated-by": {
        "data": {
          "type": "memberships",
          "id": "C7xWERND6yBTpJJVHACzVf"
        }
      },
      "deleted-by": {
        "data": null
      }
    }
  }
}

Contact Phone ¶

This resource manages updating and retrieving a specified contact phone instance.

Retrieve Contact Phone
GET`/contacts/phones/`

Retrieve an existing contact phone instance.

Example URI

GET https://api.omnigage.io/api/v1/contacts/phones/

Response 200

HideShow

Body

{
  "data": {
    "id": "RaF56o2r58hTKT7AYS9doj",
    "type": "contacts-phones",
    "attributes": {
      "label": "Phone 1",
      "phone-number": "+15197566220",
      "is-primary": true,
      "is-archived": false,
      "created-at": "2020-01-01T00:00:00+00:00",
      "updated-at": "2020-01-01T00:00:00+00:00",
      "deleted-at": null
    },
    "relationships": {
      "contact": {
        "data": {
          "type": "contacts",
          "id": "vytxeTZskVKR7C7WgdSP3d"
        }
      },
      "created-by": {
        "data": {
          "type": "memberships",
          "id": "C7xWERND6yBTpJJVHACzVf"
        }
      },
      "updated-by": {
        "data": {
          "type": "memberships",
          "id": "C7xWERND6yBTpJJVHACzVf"
        }
      },
      "deleted-by": {
        "data": null
      }
    }
  }
}

Update Contact Phone
PATCH`/contacts/phones/`

Update an existing contact phone instance.

Example URI

PATCH https://api.omnigage.io/api/v1/contacts/phones/

Request

HideShow

Body

{
  "data": {
    "id": "RaF56o2r58hTKT7AYS9doj",
    "type": "contacts-phones",
    "attributes": {
      "label": "Phone 1",
      "phone-number": "+15197566220",
      "is-primary": true,
      "is-archived": false,
      "created-at": "2020-01-01T00:00:00+00:00",
      "updated-at": "2020-01-01T00:00:00+00:00",
      "deleted-at": null
    },
    "relationships": {
      "contact": {
        "data": {
          "type": "contacts",
          "id": "vytxeTZskVKR7C7WgdSP3d"
        }
      },
      "created-by": {
        "data": {
          "type": "memberships",
          "id": "C7xWERND6yBTpJJVHACzVf"
        }
      },
      "updated-by": {
        "data": {
          "type": "memberships",
          "id": "C7xWERND6yBTpJJVHACzVf"
        }
      },
      "deleted-by": {
        "data": null
      }
    }
  }
}

Response 202

HideShow

Body

{
  "data": {
    "id": "RaF56o2r58hTKT7AYS9doj",
    "type": "contacts-phones",
    "attributes": {
      "label": "Phone 1",
      "phone-number": "+15197566220",
      "is-primary": true,
      "is-archived": false,
      "created-at": "2020-01-01T00:00:00+00:00",
      "updated-at": "2020-01-01T00:00:00+00:00",
      "deleted-at": null
    },
    "relationships": {
      "contact": {
        "data": {
          "type": "contacts",
          "id": "vytxeTZskVKR7C7WgdSP3d"
        }
      },
      "created-by": {
        "data": {
          "type": "memberships",
          "id": "C7xWERND6yBTpJJVHACzVf"
        }
      },
      "updated-by": {
        "data": {
          "type": "memberships",
          "id": "C7xWERND6yBTpJJVHACzVf"
        }
      },
      "deleted-by": {
        "data": null
      }
    }
  }
}

Delete Contact Phone
DELETE`/contacts/phones/`

Sets the is-archived field’s value to true. Note: The actual instance is not deleted.

Example URI

DELETE https://api.omnigage.io/api/v1/contacts/phones/

Response 204

Contact Email Collection ¶

This resource manages the retrieval of contact email collections and the creation of email instances.

Retrieve Contact Emails
GET`/contacts/emails{?include,filter,sort,page}`

Retrieve a collection of contact emails.

Example URI

GET https://api.omnigage.io/api/v1/contacts/emails?include=&filter=1&sort=created-at&page=10

URI Parameters

HideShow

include: string (optional)
Include one ore more related relationships using comma separated name.
sort: string (optional) Example: created-at
Sort on one or more fields using comma separated values.
filter: string (optional) Example: 1
Filter on one or more fields using comma separated values filter[field]=1,2.
page: string (optional) Example: 10
Use page[limit]=10 to reduce the number of instances returned. Use ?page[offset]=10 to skip this many instances.

Response 200

HideShow

Body

{
  "links": {
    "self": "/contacts/vytxeTZskVKR7C7WgdSP3d/emails",
    "next": "/contacts/vytxeTZskVKR7C7WgdSP3d/emails?page[offset]=10",
    "last": "/contacts/vytxeTZskVKR7C7WgdSP3d/emails?page[offset]=100"
  },
  "meta": {
    "total": 110
  },
  "data": [
    {
      "id": "RaF56o2r58hTKT7AYS9doj",
      "type": "contacts-emails",
      "attributes": {
        "label": "Email 1",
        "email-address": "alexander.bell@bell-labs.com",
        "is-primary": true,
        "is-archived": false,
        "created-at": "2020-01-01T00:00:00+00:00",
        "updated-at": "2020-01-01T00:00:00+00:00",
        "deleted-at": null
      },
      "relationships": {
        "contact": {
          "data": {
            "type": "contacts",
            "id": "vytxeTZskVKR7C7WgdSP3d"
          }
        },
        "created-by": {
          "data": {
            "type": "memberships",
            "id": "C7xWERND6yBTpJJVHACzVf"
          }
        },
        "updated-by": {
          "data": {
            "type": "memberships",
            "id": "C7xWERND6yBTpJJVHACzVf"
          }
        },
        "deleted-by": {
          "data": null
        }
      }
    }
  ]
}

Create Contact Email
POST`/contacts/emails`

Create a new contact instance.

Example URI

POST https://api.omnigage.io/api/v1/contacts/emails

Request

HideShow

Body

{
  "data": {
    "type": "contacts-emails",
    "attributes": {
      "label": "Email 1",
      "email-address": "alexander.bell@bell-labs.com"
    },
    "relationships": {
      "contact": {
        "data": {
          "type": "contacts",
          "id": "vytxeTZskVKR7C7WgdSP3d"
        }
      }
    }
  }
}

Response 201

HideShow

Body

{
  "data": {
    "id": "RaF56o2r58hTKT7AYS9doj",
    "type": "contacts-emails",
    "attributes": {
      "label": "Email 1",
      "email-address": "alexander.bell@bell-labs.com",
      "is-primary": true,
      "is-archived": false,
      "created-at": "2020-01-01T00:00:00+00:00",
      "updated-at": "2020-01-01T00:00:00+00:00",
      "deleted-at": null
    },
    "relationships": {
      "contact": {
        "data": {
          "type": "contacts",
          "id": "vytxeTZskVKR7C7WgdSP3d"
        }
      },
      "created-by": {
        "data": {
          "type": "memberships",
          "id": "C7xWERND6yBTpJJVHACzVf"
        }
      },
      "updated-by": {
        "data": {
          "type": "memberships",
          "id": "C7xWERND6yBTpJJVHACzVf"
        }
      },
      "deleted-by": {
        "data": null
      }
    }
  }
}

Contact Email ¶

This resource manages updating and retrieving a specified contact email instance.

Retrieve Contact Email
GET`/contacts/emails/`

Retrieve an existing contact email instance.

Example URI

GET https://api.omnigage.io/api/v1/contacts/emails/

Response 200

HideShow

Body

{
  "data": {
    "id": "RaF56o2r58hTKT7AYS9doj",
    "type": "contacts-emails",
    "attributes": {
      "label": "Email 1",
      "email-address": "alexander.bell@bell-labs.com",
      "is-primary": true,
      "is-archived": false,
      "created-at": "2020-01-01T00:00:00+00:00",
      "updated-at": "2020-01-01T00:00:00+00:00",
      "deleted-at": null
    },
    "relationships": {
      "contact": {
        "data": {
          "type": "contacts",
          "id": "vytxeTZskVKR7C7WgdSP3d"
        }
      },
      "created-by": {
        "data": {
          "type": "memberships",
          "id": "C7xWERND6yBTpJJVHACzVf"
        }
      },
      "updated-by": {
        "data": {
          "type": "memberships",
          "id": "C7xWERND6yBTpJJVHACzVf"
        }
      },
      "deleted-by": {
        "data": null
      }
    }
  }
}

Update Contact Email
PATCH`/contacts/emails/`

Update an existing contact email instance.

Example URI

PATCH https://api.omnigage.io/api/v1/contacts/emails/

Request

HideShow

Body

{
  "data": {
    "id": "RaF56o2r58hTKT7AYS9doj",
    "type": "contacts-emails",
    "attributes": {
      "label": "Email 1",
      "email-address": "alexander.bell@bell-labs.com",
      "is-primary": true,
      "is-archived": false,
      "created-at": "2020-01-01T00:00:00+00:00",
      "updated-at": "2020-01-01T00:00:00+00:00",
      "deleted-at": null
    },
    "relationships": {
      "contact": {
        "data": {
          "type": "contacts",
          "id": "vytxeTZskVKR7C7WgdSP3d"
        }
      },
      "created-by": {
        "data": {
          "type": "memberships",
          "id": "C7xWERND6yBTpJJVHACzVf"
        }
      },
      "updated-by": {
        "data": {
          "type": "memberships",
          "id": "C7xWERND6yBTpJJVHACzVf"
        }
      },
      "deleted-by": {
        "data": null
      }
    }
  }
}

Response 202

HideShow

Body

{
  "data": {
    "id": "RaF56o2r58hTKT7AYS9doj",
    "type": "contacts-emails",
    "attributes": {
      "label": "Email 1",
      "email-address": "alexander.bell@bell-labs.com",
      "is-primary": true,
      "is-archived": false,
      "created-at": "2020-01-01T00:00:00+00:00",
      "updated-at": "2020-01-01T00:00:00+00:00",
      "deleted-at": null
    },
    "relationships": {
      "contact": {
        "data": {
          "type": "contacts",
          "id": "vytxeTZskVKR7C7WgdSP3d"
        }
      },
      "created-by": {
        "data": {
          "type": "memberships",
          "id": "C7xWERND6yBTpJJVHACzVf"
        }
      },
      "updated-by": {
        "data": {
          "type": "memberships",
          "id": "C7xWERND6yBTpJJVHACzVf"
        }
      },
      "deleted-by": {
        "data": null
      }
    }
  }
}

Delete Contact Email
DELETE`/contacts/emails/`

Sets the is-archived field’s value to true. Note: The actual instance is not deleted.

Example URI

DELETE https://api.omnigage.io/api/v1/contacts/emails/

Response 204

Contact Note Collection ¶

This resource manages the retrieval of a given contact’s notes and creation.

Note: By default, all is-public notes are returned across all memberships for a given contact. Additionally, notes with is-public set to false are included for the current authenticated membership.

Retrieve Contact Notes
GET`/contacts/notes{?include,filter,sort,page}`

Retrieve a collection of contact notes.

Example URI

GET https://api.omnigage.io/api/v1/contacts/notes?include=&filter=1&sort=created-at&page=10

URI Parameters

HideShow

include: string (optional)
Include one ore more related relationships using comma separated name.
sort: string (optional) Example: created-at
Sort on one or more fields using comma separated values.
filter: string (optional) Example: 1
Filter on one or more fields using comma separated values filter[field]=1,2.
page: string (optional) Example: 10
Use page[limit]=10 to reduce the number of instances returned. Use ?page[offset]=10 to skip this many instances.

Response 200

HideShow

Body

{
  "links": {
    "self": "/contacts/vytxeTZskVKR7C7WgdSP3d/notes",
    "next": "/contacts/vytxeTZskVKR7C7WgdSP3d/notes?page[offset]=10",
    "last": "/contacts/vytxeTZskVKR7C7WgdSP3d/notes?page[offset]=100"
  },
  "meta": {
    "total": 110
  },
  "data": [
    {
      "id": "RaF56o2r58hTKT7AYS9doj",
      "type": "contacts-notes",
      "attributes": {
        "subject": null,
        "body": "A connoisseur of fine wines.",
        "is-public": false,
        "is-archived": false,
        "created-at": "2020-01-01T00:00:00+00:00",
        "updated-at": "2020-01-01T00:00:00+00:00",
        "deleted-at": null
      },
      "relationships": {
        "contact": {
          "data": {
            "type": "contacts",
            "id": "vytxeTZskVKR7C7WgdSP3d"
          }
        },
        "created-by": {
          "data": {
            "type": "memberships",
            "id": "C7xWERND6yBTpJJVHACzVf"
          }
        },
        "updated-by": {
          "data": {
            "type": "memberships",
            "id": "C7xWERND6yBTpJJVHACzVf"
          }
        },
        "deleted-by": {
          "data": null
        }
      }
    }
  ]
}

Create Contact Note
POST`/contacts/notes`

Create a new contact note instance.

Example URI

POST https://api.omnigage.io/api/v1/contacts/notes

Request

HideShow

Body

{
  "data": {
    "type": "contacts-notes",
    "attributes": {
      "body": "A connoisseur of fine wines."
    },
    "relationships": {
      "contact": {
        "data": {
          "type": "contacts",
          "id": "vytxeTZskVKR7C7WgdSP3d"
        }
      }
    }
  }
}

Response 201

HideShow

Body

{
  "data": {
    "id": "RaF56o2r58hTKT7AYS9doj",
    "type": "contacts-notes",
    "attributes": {
      "subject": null,
      "body": "A connoisseur of fine wines.",
      "is-public": false,
      "is-archived": false,
      "created-at": "2020-01-01T00:00:00+00:00",
      "updated-at": "2020-01-01T00:00:00+00:00",
      "deleted-at": null
    },
    "relationships": {
      "contact": {
        "data": {
          "type": "contacts",
          "id": "vytxeTZskVKR7C7WgdSP3d"
        }
      },
      "created-by": {
        "data": {
          "type": "memberships",
          "id": "C7xWERND6yBTpJJVHACzVf"
        }
      },
      "updated-by": {
        "data": {
          "type": "memberships",
          "id": "C7xWERND6yBTpJJVHACzVf"
        }
      },
      "deleted-by": {
        "data": null
      }
    }
  }
}

Contact Note ¶

This resource manages updating and retrieving a specified contact note instance.

Retrieve Contact Note
GET`/contacts/notes/`

Retrieve an existing contact note instance.

Example URI

GET https://api.omnigage.io/api/v1/contacts/notes/

Response 200

HideShow

Body

{
  "data": {
    "id": "RaF56o2r58hTKT7AYS9doj",
    "type": "contacts-notes",
    "attributes": {
      "subject": null,
      "body": "A connoisseur of fine wines.",
      "is-public": false,
      "is-archived": false,
      "created-at": "2020-01-01T00:00:00+00:00",
      "updated-at": "2020-01-01T00:00:00+00:00",
      "deleted-at": null
    },
    "relationships": {
      "contact": {
        "data": {
          "type": "contacts",
          "id": "vytxeTZskVKR7C7WgdSP3d"
        }
      },
      "created-by": {
        "data": {
          "type": "memberships",
          "id": "C7xWERND6yBTpJJVHACzVf"
        }
      },
      "updated-by": {
        "data": {
          "type": "memberships",
          "id": "C7xWERND6yBTpJJVHACzVf"
        }
      },
      "deleted-by": {
        "data": null
      }
    }
  }
}

Update Contact Note
PATCH`/contacts/notes/`

Update an existing contact note instance.

Note: Only the creator can update their note.

Example URI

PATCH https://api.omnigage.io/api/v1/contacts/notes/

Request

HideShow

Body

{
  "data": {
    "id": "RaF56o2r58hTKT7AYS9doj",
    "type": "contacts-notes",
    "attributes": {
      "subject": null,
      "body": "A connoisseur of fine wines.",
      "is-public": false,
      "is-archived": false,
      "created-at": "2020-01-01T00:00:00+00:00",
      "updated-at": "2020-01-01T00:00:00+00:00",
      "deleted-at": null
    },
    "relationships": {
      "contact": {
        "data": {
          "type": "contacts",
          "id": "vytxeTZskVKR7C7WgdSP3d"
        }
      },
      "created-by": {
        "data": {
          "type": "memberships",
          "id": "C7xWERND6yBTpJJVHACzVf"
        }
      },
      "updated-by": {
        "data": {
          "type": "memberships",
          "id": "C7xWERND6yBTpJJVHACzVf"
        }
      },
      "deleted-by": {
        "data": null
      }
    }
  }
}

Response 202

HideShow

Body

{
  "data": {
    "id": "RaF56o2r58hTKT7AYS9doj",
    "type": "contacts-notes",
    "attributes": {
      "subject": null,
      "body": "A connoisseur of fine wines.",
      "is-public": false,
      "is-archived": false,
      "created-at": "2020-01-01T00:00:00+00:00",
      "updated-at": "2020-01-01T00:00:00+00:00",
      "deleted-at": null
    },
    "relationships": {
      "contact": {
        "data": {
          "type": "contacts",
          "id": "vytxeTZskVKR7C7WgdSP3d"
        }
      },
      "created-by": {
        "data": {
          "type": "memberships",
          "id": "C7xWERND6yBTpJJVHACzVf"
        }
      },
      "updated-by": {
        "data": {
          "type": "memberships",
          "id": "C7xWERND6yBTpJJVHACzVf"
        }
      },
      "deleted-by": {
        "data": null
      }
    }
  }
}

Delete Contact Note
DELETE`/contacts/notes/`

Sets the is-archived field’s value to true. Note: The actual instance is not deleted.

Note: Only the creator can delete their note.

Example URI

DELETE https://api.omnigage.io/api/v1/contacts/notes/

Response 204

Contact Collaborator Collection ¶

This resource manages the retrieval of collaborator collections and the creation of collaborator instances.

Retrieve Contact Collaborators
GET`/contacts/collaborators{?include,sort,filter,page}`

Retrieve a collection of collaborators.

Example URI

GET https://api.omnigage.io/api/v1/contacts/collaborators?include=&sort=created-at&filter=1&page=10

URI Parameters

HideShow

include: string (optional)
Include one ore more related relationships using comma separated name.
sort: string (optional) Example: created-at
Sort on one or more fields using comma separated values.
filter: string (optional) Example: 1
Filter on one or more fields using comma separated values filter[field]=1,2.
page: string (optional) Example: 10
Use page[limit]=10 to reduce the number of instances returned. Use ?page[offset]=10 to skip this many instances.

Response 200

HideShow

Body

{
  "links": {
    "self": "/contacts/97iQjGNFLTZ5oxfYTKinwo/collaborators",
    "next": "/contacts/97iQjGNFLTZ5oxfYTKinwo/collaborators?page[offset]=10",
    "last": "/contacts/97iQjGNFLTZ5oxfYTKinwo/collaborators?page[offset]=100"
  },
  "meta": {
    "total": 1
  },
  "data": [
    {
      "id": "RaF56o2r58hTKT7AYS9doj",
      "type": "contacts-collaborators",
      "attributes": {
        "permission": "write",
        "is-archived": false,
        "created-at": "2020-01-01T00:00:00+00:00",
        "updated-at": "2020-01-01T00:00:00+00:00",
        "deleted-at": null
      },
      "relationships": {
        "membership": {
          "data": {
            "type": "memberships",
            "id": "6jVhCt5kE2p6e7B7SX9CGe"
          }
        },
        "team": {
          "data": null
        },
        "contact": {
          "data": {
            "type": "contacts",
            "id": "97iQjGNFLTZ5oxfYTKinwo"
          }
        },
        "created-by": {
          "data": {
            "type": "memberships",
            "id": "C7xWERND6yBTpJJVHACzVf"
          }
        },
        "updated-by": {
          "data": {
            "type": "memberships",
            "id": "C7xWERND6yBTpJJVHACzVf"
          }
        },
        "deleted-by": {
          "data": null
        }
      }
    }
  ]
}

Create Contact Collaborator
POST`/contacts/collaborators`

Create a new collaborator instance.

Example URI

POST https://api.omnigage.io/api/v1/contacts/collaborators

Request

HideShow

Body

{
  "data": {
    "type": "contacts-collaborators",
    "attributes": {
      "permission": "write"
    },
    "relationships": {
      "membership": {
        "data": {
          "type": "memberships",
          "id": "6jVhCt5kE2p6e7B7SX9CGe"
        }
      },
      "contact": {
        "data": {
          "type": "contacts",
          "id": "97iQjGNFLTZ5oxfYTKinwo"
        }
      }
    }
  }
}

Response 201

HideShow

Body

{
  "data": {
    "id": "RaF56o2r58hTKT7AYS9doj",
    "type": "contacts-collaborators",
    "attributes": {
      "permission": "write",
      "is-archived": false,
      "created-at": "2020-01-01T00:00:00+00:00",
      "updated-at": "2020-01-01T00:00:00+00:00",
      "deleted-at": null
    },
    "relationships": {
      "membership": {
        "data": {
          "type": "memberships",
          "id": "6jVhCt5kE2p6e7B7SX9CGe"
        }
      },
      "team": {
        "data": null
      },
      "contact": {
        "data": {
          "type": "contacts",
          "id": "97iQjGNFLTZ5oxfYTKinwo"
        }
      },
      "created-by": {
        "data": {
          "type": "memberships",
          "id": "C7xWERND6yBTpJJVHACzVf"
        }
      },
      "updated-by": {
        "data": {
          "type": "memberships",
          "id": "C7xWERND6yBTpJJVHACzVf"
        }
      },
      "deleted-by": {
        "data": null
      }
    }
  }
}

Contact Collaborator ¶

This resource manages updating and retrieving a specified collaborator instance.

Retrieve Contact Collaborator
GET`/contacts/collaborators/`

Retrieve an existing collaborator instance.

Example URI

GET https://api.omnigage.io/api/v1/contacts/collaborators/

Response 200

HideShow

Body

{
  "data": {
    "id": "RaF56o2r58hTKT7AYS9doj",
    "type": "contacts-collaborators",
    "attributes": {
      "permission": "write",
      "is-archived": false,
      "created-at": "2020-01-01T00:00:00+00:00",
      "updated-at": "2020-01-01T00:00:00+00:00",
      "deleted-at": null
    },
    "relationships": {
      "membership": {
        "data": {
          "type": "memberships",
          "id": "6jVhCt5kE2p6e7B7SX9CGe"
        }
      },
      "team": {
        "data": null
      },
      "contact": {
        "data": {
          "type": "contacts",
          "id": "97iQjGNFLTZ5oxfYTKinwo"
        }
      },
      "created-by": {
        "data": {
          "type": "memberships",
          "id": "C7xWERND6yBTpJJVHACzVf"
        }
      },
      "updated-by": {
        "data": {
          "type": "memberships",
          "id": "C7xWERND6yBTpJJVHACzVf"
        }
      },
      "deleted-by": {
        "data": null
      }
    }
  }
}

Update Contact Collaborator
PATCH`/contacts/collaborators/`

Update an existing collaborator instance.

Note: A membership cannot edit their own instance.

Example URI

PATCH https://api.omnigage.io/api/v1/contacts/collaborators/

Request

HideShow

Body

{
  "data": {
    "id": "RaF56o2r58hTKT7AYS9doj",
    "type": "contacts-collaborators",
    "attributes": {
      "permission": "write",
      "is-archived": false,
      "created-at": "2020-01-01T00:00:00+00:00",
      "updated-at": "2020-01-01T00:00:00+00:00",
      "deleted-at": null
    },
    "relationships": {
      "membership": {
        "data": {
          "type": "memberships",
          "id": "6jVhCt5kE2p6e7B7SX9CGe"
        }
      },
      "team": {
        "data": null
      },
      "contact": {
        "data": {
          "type": "contacts",
          "id": "97iQjGNFLTZ5oxfYTKinwo"
        }
      },
      "created-by": {
        "data": {
          "type": "memberships",
          "id": "C7xWERND6yBTpJJVHACzVf"
        }
      },
      "updated-by": {
        "data": {
          "type": "memberships",
          "id": "C7xWERND6yBTpJJVHACzVf"
        }
      },
      "deleted-by": {
        "data": null
      }
    }
  }
}

Response 202

HideShow

Body

{
  "data": {
    "id": "RaF56o2r58hTKT7AYS9doj",
    "type": "contacts-collaborators",
    "attributes": {
      "permission": "write",
      "is-archived": false,
      "created-at": "2020-01-01T00:00:00+00:00",
      "updated-at": "2020-01-01T00:00:00+00:00",
      "deleted-at": null
    },
    "relationships": {
      "membership": {
        "data": {
          "type": "memberships",
          "id": "6jVhCt5kE2p6e7B7SX9CGe"
        }
      },
      "team": {
        "data": null
      },
      "contact": {
        "data": {
          "type": "contacts",
          "id": "97iQjGNFLTZ5oxfYTKinwo"
        }
      },
      "created-by": {
        "data": {
          "type": "memberships",
          "id": "C7xWERND6yBTpJJVHACzVf"
        }
      },
      "updated-by": {
        "data": {
          "type": "memberships",
          "id": "C7xWERND6yBTpJJVHACzVf"
        }
      },
      "deleted-by": {
        "data": null
      }
    }
  }
}

Delete Contact Collaborator
DELETE`/contacts/collaborators/`

Sets the is-archived field’s value to true. Note: The actual instance is not deleted.

Note: A membership cannot delete their own instance.

Example URI

DELETE https://api.omnigage.io/api/v1/contacts/collaborators/

Response 204

List Collection ¶

This resource manages the retrieval of list collections and the creation of list instances.

Retrieve Lists
GET`/lists{?include,filter,sort,page}`

Retrieve a collection of lists.

Example URI

GET https://api.omnigage.io/api/v1/lists?include=&filter=1&sort=created-at&page=10

URI Parameters

HideShow

include: string (optional)
Include one ore more related relationships using comma separated name.
sort: string (optional) Example: created-at
Sort on one or more fields using comma separated values.
filter: string (optional) Example: 1
Filter on one or more fields using comma separated values filter[field]=1,2.
page: string (optional) Example: 10
Use page[limit]=10 to reduce the number of instances returned. Use ?page[offset]=10 to skip this many instances.

Response 200

HideShow

Body

{
  "links": {
    "self": "/lists",
    "next": "/lists?page[offset]=10",
    "last": "/lists?page[offset]=100"
  },
  "meta": {
    "total": 110
  },
  "data": [
    {
      "id": "RaF56o2r58hTKT7AYS9doj",
      "type": "lists",
      "attributes": {
        "label": "Prospects",
        "status": "enabled",
        "contact-total": 10,
        "collaborator-total": 2,
        "is-archived": false,
        "created-at": "2020-01-01T00:00:00+00:00",
        "updated-at": "2020-01-01T00:00:00+00:00",
        "deleted-at": null
      },
      "relationships": {
        "items": {
          "links": {
            "related": "/lists/RaF56o2r58hTKT7AYS9doj/items"
          }
        },
        "created-by": {
          "data": {
            "type": "memberships",
            "id": "C7xWERND6yBTpJJVHACzVf"
          }
        },
        "updated-by": {
          "data": {
            "type": "memberships",
            "id": "C7xWERND6yBTpJJVHACzVf"
          }
        },
        "deleted-by": {
          "data": null
        }
      }
    }
  ]
}

Create List
POST`/lists`

Create a new list instance.

Example URI

POST https://api.omnigage.io/api/v1/lists

Request

HideShow

Body

{
  "data": {
    "type": "lists",
    "attributes": {
      "label": "Prospects"
    }
  }
}

Response 201

HideShow

Body

{
  "data": {
    "id": "RaF56o2r58hTKT7AYS9doj",
    "type": "lists",
    "attributes": {
      "label": "Prospects",
      "status": "enabled",
      "contact-total": 10,
      "collaborator-total": 2,
      "is-archived": false,
      "created-at": "2020-01-01T00:00:00+00:00",
      "updated-at": "2020-01-01T00:00:00+00:00",
      "deleted-at": null
    },
    "relationships": {
      "items": {
        "links": {
          "related": "/lists/RaF56o2r58hTKT7AYS9doj/items"
        }
      },
      "created-by": {
        "data": {
          "type": "memberships",
          "id": "C7xWERND6yBTpJJVHACzVf"
        }
      },
      "updated-by": {
        "data": {
          "type": "memberships",
          "id": "C7xWERND6yBTpJJVHACzVf"
        }
      },
      "deleted-by": {
        "data": null
      }
    }
  }
}

List ¶

This resource manages updating and retrieving a specified list instance.

Retrieve List
GET`/lists/`

Retrieve an existing list instance.

Example URI

GET https://api.omnigage.io/api/v1/lists/

Response 200

HideShow

Body

{
  "data": {
    "id": "RaF56o2r58hTKT7AYS9doj",
    "type": "lists",
    "attributes": {
      "label": "Prospects",
      "status": "enabled",
      "contact-total": 10,
      "collaborator-total": 2,
      "is-archived": false,
      "created-at": "2020-01-01T00:00:00+00:00",
      "updated-at": "2020-01-01T00:00:00+00:00",
      "deleted-at": null
    },
    "relationships": {
      "items": {
        "links": {
          "related": "/lists/RaF56o2r58hTKT7AYS9doj/items"
        }
      },
      "created-by": {
        "data": {
          "type": "memberships",
          "id": "C7xWERND6yBTpJJVHACzVf"
        }
      },
      "updated-by": {
        "data": {
          "type": "memberships",
          "id": "C7xWERND6yBTpJJVHACzVf"
        }
      },
      "deleted-by": {
        "data": null
      }
    }
  }
}

Update List
PATCH`/lists/`

Update an existing list instance.

Example URI

PATCH https://api.omnigage.io/api/v1/lists/

Request

HideShow

Body

{
  "data": {
    "id": "RaF56o2r58hTKT7AYS9doj",
    "type": "lists",
    "attributes": {
      "label": "Prospects",
      "status": "enabled",
      "contact-total": 10,
      "collaborator-total": 2,
      "is-archived": false,
      "created-at": "2020-01-01T00:00:00+00:00",
      "updated-at": "2020-01-01T00:00:00+00:00",
      "deleted-at": null
    },
    "relationships": {
      "items": {
        "links": {
          "related": "/lists/RaF56o2r58hTKT7AYS9doj/items"
        }
      },
      "created-by": {
        "data": {
          "type": "memberships",
          "id": "C7xWERND6yBTpJJVHACzVf"
        }
      },
      "updated-by": {
        "data": {
          "type": "memberships",
          "id": "C7xWERND6yBTpJJVHACzVf"
        }
      },
      "deleted-by": {
        "data": null
      }
    }
  }
}

Response 202

HideShow

Body

{
  "data": {
    "id": "RaF56o2r58hTKT7AYS9doj",
    "type": "lists",
    "attributes": {
      "label": "Prospects",
      "status": "enabled",
      "contact-total": 10,
      "collaborator-total": 2,
      "is-archived": false,
      "created-at": "2020-01-01T00:00:00+00:00",
      "updated-at": "2020-01-01T00:00:00+00:00",
      "deleted-at": null
    },
    "relationships": {
      "items": {
        "links": {
          "related": "/lists/RaF56o2r58hTKT7AYS9doj/items"
        }
      },
      "created-by": {
        "data": {
          "type": "memberships",
          "id": "C7xWERND6yBTpJJVHACzVf"
        }
      },
      "updated-by": {
        "data": {
          "type": "memberships",
          "id": "C7xWERND6yBTpJJVHACzVf"
        }
      },
      "deleted-by": {
        "data": null
      }
    }
  }
}

Delete List
DELETE`/lists/`

Sets the is-archived field’s value to true. Note: The actual instance is not deleted.

Example URI

DELETE https://api.omnigage.io/api/v1/lists/

Response 204

List Item Collection ¶

This resource manages the retrieval of a given list’s items and relationship creation.

Retrieve List Items
GET`/lists/items{?include,filter,sort,page}`

Retrieve a collection of list items.

Example URI

GET https://api.omnigage.io/api/v1/lists/items?include=&filter=1&sort=created-at&page=10

URI Parameters

HideShow

include: string (optional)
Include one ore more related relationships using comma separated name.
sort: string (optional) Example: created-at
Sort on one or more fields using comma separated values.
filter: string (optional) Example: 1
Filter on one or more fields using comma separated values filter[field]=1,2.
page: string (optional) Example: 10
Use page[limit]=10 to reduce the number of instances returned. Use ?page[offset]=10 to skip this many instances.

Response 200

HideShow

Body

{
  "links": {
    "self": "/lists/vytxeTZskVKR7C7WgdSP3d/items",
    "next": "/lists/vytxeTZskVKR7C7WgdSP3d/items?page[offset]=10",
    "last": "/lists/vytxeTZskVKR7C7WgdSP3d/items?page[offset]=100"
  },
  "meta": {
    "total": 110
  },
  "data": [
    {
      "id": "RaF56o2r58hTKT7AYS9doj",
      "type": "lists-items",
      "attributes": {
        "is-subscribed": true,
        "is-archived": false,
        "created-at": "2020-01-01T00:00:00+00:00",
        "updated-at": "2020-01-01T00:00:00+00:00",
        "deleted-at": null
      },
      "relationships": {
        "list": {
          "data": {
            "type": "lists",
            "id": "vytxeTZskVKR7C7WgdSP3d"
          }
        },
        "contact": {
          "data": {
            "type": "contacts",
            "id": "c8sh5y9hdSMS6zVnrvf53T"
          }
        },
        "created-by": {
          "data": {
            "type": "memberships",
            "id": "C7xWERND6yBTpJJVHACzVf"
          }
        },
        "updated-by": {
          "data": {
            "type": "memberships",
            "id": "C7xWERND6yBTpJJVHACzVf"
          }
        },
        "deleted-by": {
          "data": null
        }
      }
    }
  ]
}

Create List Item
POST`/lists/items`

Create a new list item instance.

Example URI

POST https://api.omnigage.io/api/v1/lists/items

Request

HideShow

Body

{
  "data": {
    "type": "lists-items",
    "relationships": {
      "list": {
        "data": {
          "type": "lists",
          "id": "vytxeTZskVKR7C7WgdSP3d"
        }
      },
      "contact": {
        "data": {
          "type": "contacts",
          "id": "c8sh5y9hdSMS6zVnrvf53T"
        }
      }
    }
  }
}

Response 201

HideShow

Body

{
  "data": {
    "id": "RaF56o2r58hTKT7AYS9doj",
    "type": "lists-items",
    "attributes": {
      "is-subscribed": true,
      "is-archived": false,
      "created-at": "2020-01-01T00:00:00+00:00",
      "updated-at": "2020-01-01T00:00:00+00:00",
      "deleted-at": null
    },
    "relationships": {
      "list": {
        "data": {
          "type": "lists",
          "id": "vytxeTZskVKR7C7WgdSP3d"
        }
      },
      "contact": {
        "data": {
          "type": "contacts",
          "id": "c8sh5y9hdSMS6zVnrvf53T"
        }
      },
      "created-by": {
        "data": {
          "type": "memberships",
          "id": "C7xWERND6yBTpJJVHACzVf"
        }
      },
      "updated-by": {
        "data": {
          "type": "memberships",
          "id": "C7xWERND6yBTpJJVHACzVf"
        }
      },
      "deleted-by": {
        "data": null
      }
    }
  }
}

List Item ¶

This resource manages updating and retrieving a specified list item instance.

Note: The primary id is the same as the associated contact id.

Retrieve List Item
GET`/lists/items/`

Retrieve an existing list item instance.

Example URI

GET https://api.omnigage.io/api/v1/lists/items/

Response 200

HideShow

Body

{
  "data": {
    "id": "RaF56o2r58hTKT7AYS9doj",
    "type": "lists-items",
    "attributes": {
      "is-subscribed": true,
      "is-archived": false,
      "created-at": "2020-01-01T00:00:00+00:00",
      "updated-at": "2020-01-01T00:00:00+00:00",
      "deleted-at": null
    },
    "relationships": {
      "list": {
        "data": {
          "type": "lists",
          "id": "vytxeTZskVKR7C7WgdSP3d"
        }
      },
      "contact": {
        "data": {
          "type": "contacts",
          "id": "c8sh5y9hdSMS6zVnrvf53T"
        }
      },
      "created-by": {
        "data": {
          "type": "memberships",
          "id": "C7xWERND6yBTpJJVHACzVf"
        }
      },
      "updated-by": {
        "data": {
          "type": "memberships",
          "id": "C7xWERND6yBTpJJVHACzVf"
        }
      },
      "deleted-by": {
        "data": null
      }
    }
  }
}

Update List Item
PATCH`/lists/items/`

Update an existing list item instance.

Example URI

PATCH https://api.omnigage.io/api/v1/lists/items/

Request

HideShow

Body

{
  "data": {
    "id": "RaF56o2r58hTKT7AYS9doj",
    "type": "lists-items",
    "attributes": {
      "is-subscribed": true,
      "is-archived": false,
      "created-at": "2020-01-01T00:00:00+00:00",
      "updated-at": "2020-01-01T00:00:00+00:00",
      "deleted-at": null
    },
    "relationships": {
      "list": {
        "data": {
          "type": "lists",
          "id": "vytxeTZskVKR7C7WgdSP3d"
        }
      },
      "contact": {
        "data": {
          "type": "contacts",
          "id": "c8sh5y9hdSMS6zVnrvf53T"
        }
      },
      "created-by": {
        "data": {
          "type": "memberships",
          "id": "C7xWERND6yBTpJJVHACzVf"
        }
      },
      "updated-by": {
        "data": {
          "type": "memberships",
          "id": "C7xWERND6yBTpJJVHACzVf"
        }
      },
      "deleted-by": {
        "data": null
      }
    }
  }
}

Response 202

HideShow

Body

{
  "data": {
    "id": "RaF56o2r58hTKT7AYS9doj",
    "type": "lists-items",
    "attributes": {
      "is-subscribed": true,
      "is-archived": false,
      "created-at": "2020-01-01T00:00:00+00:00",
      "updated-at": "2020-01-01T00:00:00+00:00",
      "deleted-at": null
    },
    "relationships": {
      "list": {
        "data": {
          "type": "lists",
          "id": "vytxeTZskVKR7C7WgdSP3d"
        }
      },
      "contact": {
        "data": {
          "type": "contacts",
          "id": "c8sh5y9hdSMS6zVnrvf53T"
        }
      },
      "created-by": {
        "data": {
          "type": "memberships",
          "id": "C7xWERND6yBTpJJVHACzVf"
        }
      },
      "updated-by": {
        "data": {
          "type": "memberships",
          "id": "C7xWERND6yBTpJJVHACzVf"
        }
      },
      "deleted-by": {
        "data": null
      }
    }
  }
}

Delete List Item
DELETE`/lists/items/`

Sets the is-archived field’s value to true. Note: The actual instance is not deleted.

Note: Bulk delete accepts both contacts and lists-items types.

Example URI

DELETE https://api.omnigage.io/api/v1/lists/items/

Request

HideShow

Headers

Content-Type: application/vnd.api+json;ext=bulk

Body

{
  "data": [
    {
      "id": "RaF56o2r58hTKT7AYS9doj",
      "type": "lists-items"
    },
    {
      "id": "VKR7C7WgvytxeTZskdSP3d",
      "type": "contacts"
    }
  ]
}

Response 204

List Collaborator Collection ¶

This resource manages the retrieval of collaborator collections and the creation of collaborator instances.

Retrieve List Collaborators
GET`/lists/collaborators{?include,sort,filter,page}`

Retrieve a collection of collaborators.

Example URI

GET https://api.omnigage.io/api/v1/lists/collaborators?include=&sort=created-at&filter=1&page=10

URI Parameters

HideShow

include: string (optional)
Include one ore more related relationships using comma separated name.
sort: string (optional) Example: created-at
Sort on one or more fields using comma separated values.
filter: string (optional) Example: 1
Filter on one or more fields using comma separated values filter[field]=1,2.
page: string (optional) Example: 10
Use page[limit]=10 to reduce the number of instances returned. Use ?page[offset]=10 to skip this many instances.

Response 200

HideShow

Body

{
  "links": {
    "self": "/lists/97iQjGNFLTZ5oxfYTKinwo/collaborators",
    "next": "/lists/97iQjGNFLTZ5oxfYTKinwo/collaborators?page[offset]=10",
    "last": "/lists/97iQjGNFLTZ5oxfYTKinwo/collaborators?page[offset]=100"
  },
  "meta": {
    "total": 1
  },
  "data": [
    {
      "id": "RaF56o2r58hTKT7AYS9doj",
      "type": "lists-collaborators",
      "attributes": {
        "permission": "write",
        "is-archived": false,
        "created-at": "2020-01-01T00:00:00+00:00",
        "updated-at": "2020-01-01T00:00:00+00:00",
        "deleted-at": null
      },
      "relationships": {
        "membership": {
          "data": {
            "type": "memberships",
            "id": "6jVhCt5kE2p6e7B7SX9CGe"
          }
        },
        "team": {
          "data": null
        },
        "list": {
          "data": {
            "type": "lists",
            "id": "97iQjGNFLTZ5oxfYTKinwo"
          }
        },
        "created-by": {
          "data": {
            "type": "memberships",
            "id": "C7xWERND6yBTpJJVHACzVf"
          }
        },
        "updated-by": {
          "data": {
            "type": "memberships",
            "id": "C7xWERND6yBTpJJVHACzVf"
          }
        },
        "deleted-by": {
          "data": null
        }
      }
    }
  ]
}

Create List Collaborator
POST`/lists/collaborators`

Create a new collaborator instance.

Example URI

POST https://api.omnigage.io/api/v1/lists/collaborators

Request

HideShow

Body

{
  "data": {
    "type": "lists-collaborators",
    "attributes": {
      "permission": "write"
    },
    "relationships": {
      "membership": {
        "data": {
          "type": "memberships",
          "id": "6jVhCt5kE2p6e7B7SX9CGe"
        }
      },
      "list": {
        "data": {
          "type": "lists",
          "id": "97iQjGNFLTZ5oxfYTKinwo"
        }
      }
    }
  }
}

Response 201

HideShow

Body

{
  "data": {
    "id": "RaF56o2r58hTKT7AYS9doj",
    "type": "lists-collaborators",
    "attributes": {
      "permission": "write",
      "is-archived": false,
      "created-at": "2020-01-01T00:00:00+00:00",
      "updated-at": "2020-01-01T00:00:00+00:00",
      "deleted-at": null
    },
    "relationships": {
      "membership": {
        "data": {
          "type": "memberships",
          "id": "6jVhCt5kE2p6e7B7SX9CGe"
        }
      },
      "team": {
        "data": null
      },
      "list": {
        "data": {
          "type": "lists",
          "id": "97iQjGNFLTZ5oxfYTKinwo"
        }
      },
      "created-by": {
        "data": {
          "type": "memberships",
          "id": "C7xWERND6yBTpJJVHACzVf"
        }
      },
      "updated-by": {
        "data": {
          "type": "memberships",
          "id": "C7xWERND6yBTpJJVHACzVf"
        }
      },
      "deleted-by": {
        "data": null
      }
    }
  }
}

List Collaborator ¶

This resource manages updating and retrieving a specified collaborator instance.

Retrieve List Collaborator
GET`/lists/collaborators/`

Retrieve an existing collaborator instance.

Example URI

GET https://api.omnigage.io/api/v1/lists/collaborators/

Response 200

HideShow

Body

{
  "data": {
    "id": "RaF56o2r58hTKT7AYS9doj",
    "type": "lists-collaborators",
    "attributes": {
      "permission": "write",
      "is-archived": false,
      "created-at": "2020-01-01T00:00:00+00:00",
      "updated-at": "2020-01-01T00:00:00+00:00",
      "deleted-at": null
    },
    "relationships": {
      "membership": {
        "data": {
          "type": "memberships",
          "id": "6jVhCt5kE2p6e7B7SX9CGe"
        }
      },
      "team": {
        "data": null
      },
      "list": {
        "data": {
          "type": "lists",
          "id": "97iQjGNFLTZ5oxfYTKinwo"
        }
      },
      "created-by": {
        "data": {
          "type": "memberships",
          "id": "C7xWERND6yBTpJJVHACzVf"
        }
      },
      "updated-by": {
        "data": {
          "type": "memberships",
          "id": "C7xWERND6yBTpJJVHACzVf"
        }
      },
      "deleted-by": {
        "data": null
      }
    }
  }
}

Update List Collaborator
PATCH`/lists/collaborators/`

Update an existing collaborator instance.

Note: A membership cannot edit their own instance.

Example URI

PATCH https://api.omnigage.io/api/v1/lists/collaborators/

Request

HideShow

Body

{
  "data": {
    "id": "RaF56o2r58hTKT7AYS9doj",
    "type": "lists-collaborators",
    "attributes": {
      "permission": "write",
      "is-archived": false,
      "created-at": "2020-01-01T00:00:00+00:00",
      "updated-at": "2020-01-01T00:00:00+00:00",
      "deleted-at": null
    },
    "relationships": {
      "membership": {
        "data": {
          "type": "memberships",
          "id": "6jVhCt5kE2p6e7B7SX9CGe"
        }
      },
      "team": {
        "data": null
      },
      "list": {
        "data": {
          "type": "lists",
          "id": "97iQjGNFLTZ5oxfYTKinwo"
        }
      },
      "created-by": {
        "data": {
          "type": "memberships",
          "id": "C7xWERND6yBTpJJVHACzVf"
        }
      },
      "updated-by": {
        "data": {
          "type": "memberships",
          "id": "C7xWERND6yBTpJJVHACzVf"
        }
      },
      "deleted-by": {
        "data": null
      }
    }
  }
}

Response 202

HideShow

Body

{
  "data": {
    "id": "RaF56o2r58hTKT7AYS9doj",
    "type": "lists-collaborators",
    "attributes": {
      "permission": "write",
      "is-archived": false,
      "created-at": "2020-01-01T00:00:00+00:00",
      "updated-at": "2020-01-01T00:00:00+00:00",
      "deleted-at": null
    },
    "relationships": {
      "membership": {
        "data": {
          "type": "memberships",
          "id": "6jVhCt5kE2p6e7B7SX9CGe"
        }
      },
      "team": {
        "data": null
      },
      "list": {
        "data": {
          "type": "lists",
          "id": "97iQjGNFLTZ5oxfYTKinwo"
        }
      },
      "created-by": {
        "data": {
          "type": "memberships",
          "id": "C7xWERND6yBTpJJVHACzVf"
        }
      },
      "updated-by": {
        "data": {
          "type": "memberships",
          "id": "C7xWERND6yBTpJJVHACzVf"
        }
      },
      "deleted-by": {
        "data": null
      }
    }
  }
}

Delete List Collaborator
DELETE`/lists/collaborators/`

Sets the is-archived field’s value to true. Note: The actual instance is not deleted.

Note: A membership cannot delete their own instance.

Example URI

DELETE https://api.omnigage.io/api/v1/lists/collaborators/

Response 204

Import Resources ¶

Import Contact Collection ¶

This resource manages the retrieval of import contact collections and the creation of import contact instances.

Retrieve Import Contacts
GET`/import-contacts{?include,filter,sort,page}`

Retrieve a collection of import contacts.

Example URI

GET https://api.omnigage.io/api/v1/import-contacts?include=&filter=1&sort=created-at&page=10

URI Parameters

HideShow

include: string (optional)
Include one ore more related relationships using comma separated name.
sort: string (optional) Example: created-at
Sort on one or more fields using comma separated values.
filter: string (optional) Example: 1
Filter on one or more fields using comma separated values filter[field]=1,2.
page: string (optional) Example: 10
Use page[limit]=10 to reduce the number of instances returned. Use ?page[offset]=10 to skip this many instances.

Response 200

HideShow

Body

{
  "links": {
    "self": "/import-contacts",
    "next": "/import-contacts?page[offset]=10",
    "last": "/import-contacts?page[offset]=100"
  },
  "meta": {
    "total": 110
  },
  "data": [
    {
      "id": "THWfEfDcwkgLH674YSGVxq",
      "type": "import-contacts",
      "attributes": {
        "status": "pending",
        "enable-preflights": true,
        "count-created": 0,
        "count-updated": 0,
        "count-erred": 0,
        "count-resolved": 0,
        "count-skipped": 0,
        "count-total": 0,
        "unique-primary-phone": true,
        "unique-primary-email": true,
        "update-pruning": false,
        "created-at": "2020-01-01T00:00:00+00:00",
        "updated-at": "2020-01-01T00:00:00+00:00"
      },
      "relationships": {
        "original-file": {
          "data": {
            "type": "files",
            "id": "ReN6UbN4zgaWfvFSM8csUZ"
          }
        },
        "list": {
          "data": {
            "type": "lists",
            "id": "2EVtt3RKnATTRh72CrmEnF"
          }
        },
        "results": {
          "links": {
            "related": "/import-contacts/THWfEfDcwkgLH674YSGVxq/results"
          }
        },
        "created-by": {
          "data": {
            "type": "memberships",
            "id": "C7xWERND6yBTpJJVHACzVf"
          }
        },
        "updated-by": {
          "data": {
            "type": "memberships",
            "id": "C7xWERND6yBTpJJVHACzVf"
          }
        }
      }
    }
  ]
}

Create Import Contact
POST`/import-contacts`

Create a new import contact instance.

During an import, the following rules are taken into consideration:

If the id is present, will attempt to update the contact.
When no id is present, will use unique identifying information to attempt to look up the contact (phone-number and email-address).
If a single contact is located, an update will commence. Note: In order to perform an update, the membership must have collaborator access of write or better. A membership with read access will result in the row being skipped.
During an update, if one part of the update fails (such as validation due to a missing field) the update for the given contact will result in an error. For example, if “Address 2” is missing a required field, the entire contact will not be updated and will be marked as error avoiding a partial update.
If unable to locate the contact, will attempt to create a contact.

The CSV file is a combination of static columns along with a pattern for importing multiple phones, emails and addresses.

Note: Each field maps back to attributes for contacts, contacts-addresses, contacts-phones and contacts-emails. For full documentation around each field, consult the related resource.

The following fields are static. The only two columns required are first-name and last-name.

id (string, optional) - For explicitly associating the import record with a contacts id.
first-name: Alexander (string, required)
last-name: Bell (string, required)
title: Mr. (string, optional)
birthday: 1847-03-03 (string, optional) - ISO 8601 YYYY-MM-DD
gender (enum[string], optional)
- Members
  - female
  - male
status (enum[string], optional)
- Default: enabled
- Members
  - enabled
  - disabled
company: Bell Company (string, optional)
timezone (string, optional) - See /timezones for valid options.
is-archived (boolean, optional) - Whether or not this contact is archived.
- Default: false

Multiple addresses can be imported by creating columns prefixed incrementally with addr1-. Below are the supported columns:

addr1-id (string, optional) - For explicitly associating the address with a contacts-addresses id.
addr1-label (string, optional)
addr1-address1 (string, required)
addr1-address2 (string, optional)
addr1-city (string, optional)
addr1-state (string, optional)
addr1-zip (string, optional)
addr1-country (string, optional) - See /countries for valid keys.
addr1-is-archived (boolean, optional) - Whether or not this address is archived.
- Default: false

Multiple phones can be imported by creating columns prefixed incrementally with phone1-. Below are the supported columns:

phone1-id (string, optional) - For explicitly associating the phone with a contacts-phones id.
phone1-label (string, optional)
phone1-country-code (string, optional) - When there is a value, will prepend to phone1-phone-number.
phone1-phone-number (string, required) - E.164. Unique within the context of the contact relationship.
phone1-is-archived (boolean, optional) - Whether or not this phone is archived.
- Default: false

Multiple emails can be imported by creating columns prefixed incrementally with email1-. Below are the supported columns:

email1-id (string, optional) - For explicitly associating the email with a contacts-emails id.
email1-label (string, optional)
email1-email-address (string, required) - Unique within the context of the contact relationship.
email1-is-archived (boolean, optional) - Whether or not this email is archived.
- Default: false

Multiple notes can be imported by creating columns prefixed incrementally with note1-. Below are the supported columns:

Notes: Notes can be imported but cannot be updated.

note1-id (string, optional) - For explicitly associating the note with a contacts-notes id.
note1-subject (string, optional) - The note’s subject.
note1-body (string, required) - Accepts HTML.
note1-is-public (boolean, optional) - Whether or not a note is public. When public, will appear in the collection for other memberships.
- Default: false
note1-is-archived (boolean, optional) - Whether or not this note is archived.
- Default: false

Example URI

POST https://api.omnigage.io/api/v1/import-contacts

Request

HideShow

Body

{
  "data": {
    "type": "import-contacts",
    "relationships": {
      "upload": {
        "data": {
          "type": "uploads",
          "id": "9kQs8DntN6WUddyZmEqxne"
        }
      }
    }
  }
}

Response 201

HideShow

Body

{
    "data": {
        "id": "THWfEfDcwkgLH674YSGVxq",
        "type": "import-contacts",
        "attributes": {
            "status": "pending",
            "mapping": [
                "first-name",
                "last-name",
                null,
                "addr1-address1"
                "addr2-address1"
            ],
            "header": [
                "Firstname",
                "Lastname",
                "Married",
                "Personal Address 1",
                "Business Address 1"
            ],
            "sample": [
                "Alexander",
                "Bell",
                "yes",
                "94 Tutela Heights Road",
                null
            ],
            "enable-preflights": true,
            "count-created": 0,
            "count-updated": 0,
            "count-erred": 0,
            "count-resolved": 0,
            "count-skipped": 0,
            "count-total": 0,
            "unique-primary-phone": true,
            "unique-primary-email": true,
            "update-pruning": false,
            "created-at": "2020-01-01T00:00:00+00:00",
            "updated-at": "2020-01-01T00:00:00+00:00"
        },
        "relationships": {
            "original-file": {
                "data": {"type": "files", "id": "ReN6UbN4zgaWfvFSM8csUZ"}
            },
            "errors-file": {
                "data": {"type": "files", "id": "jNnKvALsHZaaEzgdfm2Lxr"}
            },
            "list": {
                "data": {"type": "lists", "id": "2EVtt3RKnATTRh72CrmEnF"}
            },
            "results": {
                "links": {
                    "related": "/import-contacts/THWfEfDcwkgLH674YSGVxq/results"
                }
            },
            "created-by": {
                "data": {"type": "memberships", "id": "C7xWERND6yBTpJJVHACzVf"}
            },
            "updated-by": {
                "data": {"type": "memberships", "id": "C7xWERND6yBTpJJVHACzVf"}
            }
        }
    }
}

Import Contact ¶

This resource manages retrieving a specified import contact instance.

Retrieve Import Contact
GET`/import-contacts/`

Retrieve an existing import contact instance.

Example URI

GET https://api.omnigage.io/api/v1/import-contacts/

Response 200

HideShow

Body

{
    "data": {
        "id": "THWfEfDcwkgLH674YSGVxq",
        "type": "import-contacts",
        "attributes": {
            "status": "pending",
            "mapping": [
                "first-name",
                "last-name",
                null,
                "addr1-address1"
                "addr2-address1"
            ],
            "header": [
                "Firstname",
                "Lastname",
                "Married",
                "Personal Address 1",
                "Business Address 1"
            ],
            "sample": [
                "Alexander",
                "Bell",
                "yes",
                "94 Tutela Heights Road",
                null
            ],
            "enable-preflights": true,
            "count-created": 0,
            "count-updated": 0,
            "count-erred": 0,
            "count-resolved": 0,
            "count-skipped": 0,
            "count-total": 0,
            "unique-primary-phone": true,
            "unique-primary-email": true,
            "update-pruning": false,
            "created-at": "2020-01-01T00:00:00+00:00",
            "updated-at": "2020-01-01T00:00:00+00:00"
        },
        "relationships": {
            "original-file": {
                "data": {"type": "files", "id": "ReN6UbN4zgaWfvFSM8csUZ"}
            },
            "errors-file": {
                "data": {"type": "files", "id": "jNnKvALsHZaaEzgdfm2Lxr"}
            },
            "list": {
                "data": {"type": "lists", "id": "2EVtt3RKnATTRh72CrmEnF"}
            },
            "results": {
                "links": {
                    "related": "/import-contacts/THWfEfDcwkgLH674YSGVxq/results"
                }
            },
            "created-by": {
                "data": {"type": "memberships", "id": "C7xWERND6yBTpJJVHACzVf"}
            },
            "updated-by": {
                "data": {"type": "memberships", "id": "C7xWERND6yBTpJJVHACzVf"}
            }
        }
    }
}

Update Import Contact
PATCH`/import-contacts/`

Update an existing import contact instance.

The following examples demonstrate:

Updating a pending import. When an import is in a state of pending, the list can be changed along with replacing the file by using an upload.
Moving the import from a state of pending to queued for processing. Note: Once the import is queued, it can no longer be updated.

Example URI

PATCH https://api.omnigage.io/api/v1/import-contacts/

Request

HideShow

Body

{
  "data": {
    "id": "THWfEfDcwkgLH674YSGVxq",
    "type": "import-contacts",
    "relationships": {
      "list": {
        "data": {
          "type": "lists",
          "id": "tYz3tcVXh5WGh9nUtjkSwy"
        }
      },
      "upload": {
        "data": {
          "type": "uploads",
          "id": "jWv2q7kbvpuSHDcRUPrcmt"
        }
      }
    }
  }
}

Response 202

HideShow

Body

{
    "data": {
        "id": "THWfEfDcwkgLH674YSGVxq",
        "type": "import-contacts",
        "attributes": {
            "status": "pending",
            "mapping": [
                "first-name",
                "last-name",
                null,
                "addr1-address1"
                "addr2-address1"
            ],
            "header": [
                "Firstname",
                "Lastname",
                "Married",
                "Personal Address 1",
                "Business Address 1"
            ],
            "sample": [
                "Alexander",
                "Bell",
                "yes",
                "94 Tutela Heights Road",
                null
            ],
            "enable-preflights": true,
            "count-created": 0,
            "count-updated": 0,
            "count-erred": 0,
            "count-resolved": 0,
            "count-skipped": 0,
            "count-total": 0,
            "unique-primary-phone": true,
            "unique-primary-email": true,
            "update-pruning": false,
            "created-at": "2020-01-01T00:00:00+00:00",
            "updated-at": "2020-01-01T00:00:00+00:00"
        },
        "relationships": {
            "original-file": {
                "data": {"type": "files", "id": "ReN6UbN4zgaWfvFSM8csUZ"}
            },
            "errors-file": {
                "data": {"type": "files", "id": "jNnKvALsHZaaEzgdfm2Lxr"}
            },
            "list": {
                "data": {"type": "lists", "id": "2EVtt3RKnATTRh72CrmEnF"}
            },
            "results": {
                "links": {
                    "related": "/import-contacts/THWfEfDcwkgLH674YSGVxq/results"
                }
            },
            "created-by": {
                "data": {"type": "memberships", "id": "C7xWERND6yBTpJJVHACzVf"}
            },
            "updated-by": {
                "data": {"type": "memberships", "id": "C7xWERND6yBTpJJVHACzVf"}
            }
        }
    }
}

Request Processing

HideShow

Body

{
  "data": {
    "id": "THWfEfDcwkgLH674YSGVxq",
    "type": "import-contacts",
    "attributes": {
      "status": "queued"
    }
  }
}

Response 202

HideShow

Body

{
    "data": {
        "id": "THWfEfDcwkgLH674YSGVxq",
        "type": "import-contacts",
        "attributes": {
            "status": "queued",
            "mapping": [
                "first-name",
                "last-name",
                "skipped",
                "addr1-address1"
                "addr2-address1"
            ],
            "header": [
                "Firstname",
                "Lastname",
                "Married",
                "Personal Address 1",
                "Business Address 1"
            ],
            "sample": [
                "Alexander",
                "Bell",
                "yes",
                "94 Tutela Heights Road",
                null
            ],
            "enable-preflights": true,
            "count-created": 0,
            "count-updated": 0,
            "count-erred": 0,
            "count-resolved": 0,
            "count-skipped": 0,
            "count-total": 0,
            "unique-primary-phone": true,
            "unique-primary-email": true,
            "update-pruning": false,
            "created-at": "2020-01-01T00:00:00+00:00",
            "updated-at": "2020-01-01T00:00:00+00:00"
        },
        "relationships": {
            "original-file": {
                "data": {"type": "files", "id": "ReN6UbN4zgaWfvFSM8csUZ"}
            },
            "errors-file": {
                "data": {"type": "files", "id": "jNnKvALsHZaaEzgdfm2Lxr"}
            },
            "list": {
                "data": {"type": "lists", "id": "2EVtt3RKnATTRh72CrmEnF"}
            },
            "results": {
                "links": {
                    "related": "/import-contacts/THWfEfDcwkgLH674YSGVxq/results"
                }
            },
            "created-by": {
                "data": {"type": "memberships", "id": "C7xWERND6yBTpJJVHACzVf"}
            },
            "updated-by": {
                "data": {"type": "memberships", "id": "C7xWERND6yBTpJJVHACzVf"}
            }
        }
    }
}

Import Contact Result Collection ¶

This resource manages the retrieval of a given import contact instance’s results collection.

Retrieve Import Contact Results
GET`/import-contacts/results{?include,filter,sort,page,after}`

Retrieve a collection of contact results.

Example URI

GET https://api.omnigage.io/api/v1/import-contacts/results?include=&filter=1&sort=created-at&page=10&after=RaF56o2r58hTKT7AYS9doj

URI Parameters

HideShow

include: string (optional)
Include one ore more related relationships using comma separated name.
sort: string (optional) Example: created-at
Sort on one or more fields using comma separated values.
filter: string (optional) Example: 1
Filter on one or more fields using comma separated values filter[field]=1,2.
page: string (optional) Example: 10
Use page[limit]=10 to reduce the number of instances returned. Use ?page[offset]=10 to skip this many instances.
after: string (optional) Example: RaF56o2r58hTKT7AYS9doj
Paginate after the specified id.

Response 200

HideShow

Body

{
  "links": {
    "self": "/import-contacts/eYExtt6G7UePgwFirh3DqL/results",
    "next": "/import-contacts/eYExtt6G7UePgwFirh3DqL/results?page[offset]=10",
    "last": "/import-contacts/eYExtt6G7UePgwFirh3DqL/results?page[offset]=100"
  },
  "meta": {
    "total": 110,
    "after-count": 55
  },
  "data": [
    {
      "id": "RaF56o2r58hTKT7AYS9doj",
      "type": "import-contacts-results",
      "attributes": {
        "status": "error",
        "reason": "validation",
        "line": 242,
        "message": "Phone 2 missing required `phone-number` field.",
        "created-at": "2020-01-01T00:00:00+00:00",
        "updated-at": "2020-01-01T00:00:00+00:00"
      },
      "relationships": {
        "import-contact": {
          "data": {
            "type": "import-contacts",
            "id": "yu8Y8WBFuGX7ZqMLd5doXT"
          }
        },
        "contact": {
          "data": {
            "type": "contacts",
            "id": "EJW888QJ2kQtGUaASZ8UUm"
          }
        },
        "preflight": {
          "data": {
            "type": "import-contacts-preflights",
            "id": "8wNk4trDz9tb74wKJ7gfoj"
          }
        },
        "created-by": {
          "data": {
            "type": "memberships",
            "id": "C7xWERND6yBTpJJVHACzVf"
          }
        },
        "updated-by": {
          "data": {
            "type": "memberships",
            "id": "C7xWERND6yBTpJJVHACzVf"
          }
        }
      }
    }
  ]
}

Import Contact Result ¶

This resource manages retrieving a specified result instance.

Retrieve Import Contact Result
GET`/import-contacts/results/`

Retrieve an existing contact result instance.

Example URI

GET https://api.omnigage.io/api/v1/import-contacts/results/

Response 200

HideShow

Body

{
  "data": {
    "id": "RaF56o2r58hTKT7AYS9doj",
    "type": "import-contacts-results",
    "attributes": {
      "status": "error",
      "reason": "validation",
      "line": 242,
      "message": "Phone 2 missing required `phone-number` field.",
      "created-at": "2020-01-01T00:00:00+00:00",
      "updated-at": "2020-01-01T00:00:00+00:00"
    },
    "relationships": {
      "import-contact": {
        "data": {
          "type": "import-contacts",
          "id": "yu8Y8WBFuGX7ZqMLd5doXT"
        }
      },
      "contact": {
        "data": {
          "type": "contacts",
          "id": "EJW888QJ2kQtGUaASZ8UUm"
        }
      },
      "preflight": {
        "data": {
          "type": "import-contacts-preflights",
          "id": "8wNk4trDz9tb74wKJ7gfoj"
        }
      },
      "created-by": {
        "data": {
          "type": "memberships",
          "id": "C7xWERND6yBTpJJVHACzVf"
        }
      },
      "updated-by": {
        "data": {
          "type": "memberships",
          "id": "C7xWERND6yBTpJJVHACzVf"
        }
      }
    }
  }
}

Update Import Contact Result
PATCH`/import-contacts/results/`

Update an existing import contact result instance.

Example URI

PATCH https://api.omnigage.io/api/v1/import-contacts/results/

Request

HideShow

Body

{
  "data": {
    "id": "RaF56o2r58hTKT7AYS9doj",
    "type": "import-contacts-results",
    "attributes": {
      "status": "skipped"
    }
  }
}

Response 202

HideShow

Body

{
  "data": {
    "id": "RaF56o2r58hTKT7AYS9doj",
    "type": "import-contacts-results",
    "attributes": {
      "status": "skipped",
      "reason": "validation",
      "line": 242,
      "message": "Phone 2 missing required `phone-number` field.",
      "created-at": "2020-01-01T00:00:00+00:00",
      "updated-at": "2020-01-01T00:00:00+00:00"
    },
    "relationships": {
      "import-contact": {
        "data": {
          "type": "import-contacts",
          "id": "yu8Y8WBFuGX7ZqMLd5doXT"
        }
      },
      "contact": {
        "data": {
          "type": "contacts",
          "id": "EJW888QJ2kQtGUaASZ8UUm"
        }
      },
      "preflight": {
        "data": {
          "type": "import-contacts-preflights",
          "id": "8wNk4trDz9tb74wKJ7gfoj"
        }
      }
    }
  }
}

Import Contact Preflight ¶

This resource manages retrieving and updating a specified preflight instance.

Retrieve Import Contact Preflight
GET`/import-contacts/preflights/`

Retrieve an existing contact preflight instance.

Example URI

GET https://api.omnigage.io/api/v1/import-contacts/preflights/

Response 200

HideShow

Body

{
  "data": {
    "id": "RaF56o2r58hTKT7AYS9doj",
    "type": "import-contacts-preflights",
    "attributes": {
      "row": {
        "first-name": "Alexander",
        "last-name": "",
        "addr1-address1": "94 Tutela Heights Road"
      },
      "created-at": "2020-01-01T00:00:00+00:00",
      "updated-at": "2020-01-01T00:00:00+00:00"
    },
    "relationships": {
      "import-contact-result": {
        "data": {
          "type": "import-contacts-results",
          "id": "RaF56o2r58hTKT7AYS9doj"
        }
      }
    }
  }
}

Update Import Contact Preflight
PATCH`/import-contacts/preflights/`

Update an existing import contact preflight instance.

Example URI

PATCH https://api.omnigage.io/api/v1/import-contacts/preflights/

Request

HideShow

Body

{
  "data": {
    "id": "RaF56o2r58hTKT7AYS9doj",
    "type": "import-contacts-preflights",
    "attributes": {
      "row": {
        "first-name": "Alexander",
        "last-name": "Bell",
        "addr1-address1": "94 Tutela Heights Road"
      }
    }
  }
}

Response 202

HideShow

Body

{
  "data": {
    "id": "RaF56o2r58hTKT7AYS9doj",
    "type": "import-contacts-preflights",
    "attributes": {
      "row": {
        "first-name": "Alexander",
        "last-name": "Bell",
        "addr1-address1": "94 Tutela Heights Road"
      },
      "created-at": "2020-01-01T00:00:00+00:00",
      "updated-at": "2020-01-01T00:00:00+00:00"
    },
    "relationships": {
      "import-contact-result": {
        "data": {
          "type": "import-contacts-results",
          "id": "RaF56o2r58hTKT7AYS9doj"
        }
      }
    }
  }
}

Import Membership Collection ¶

This resources facilitates bulk membership creation including progress tracking and detailed logs.

Retrieve Import Memberships
GET`/import-memberships{?include,filter,sort,page}`

Retrieve a collection of import memberships.

Example URI

GET https://api.omnigage.io/api/v1/import-memberships?include=&filter=1&sort=created-at&page=10

URI Parameters

HideShow

include: string (optional)
Include one ore more related relationships using comma separated name.
sort: string (optional) Example: created-at
Sort on one or more fields using comma separated values.
filter: string (optional) Example: 1
Filter on one or more fields using comma separated values filter[field]=1,2.
page: string (optional) Example: 10
Use page[limit]=10 to reduce the number of instances returned. Use ?page[offset]=10 to skip this many instances.

Response 200

HideShow

Body

{
  "links": {
    "self": "/import-memberships",
    "next": "/import-memberships?page[offset]=10",
    "last": "/import-memberships?page[offset]=100"
  },
  "meta": {
    "total": 1
  },
  "data": [
    {
      "id": "THWfEfDcwkgLH674YSGVxq",
      "type": "import-memberships",
      "attributes": {
        "status": "completed",
        "count-created": 27,
        "count-skipped": 0,
        "count-erred": 0,
        "count-total": 27,
        "created-at": "2020-01-01T00:00:00+00:00",
        "updated-at": "2020-01-01T00:00:00+00:00"
      },
      "relationships": {
        "upload": {
          "data": null
        },
        "file": {
          "data": {
            "type": "files",
            "id": "ReN6UbN4zgaWfvFSM8csUZ"
          }
        },
        "results": {
          "links": {
            "related": "/import-memberships/THWfEfDcwkgLH674YSGVxq/results"
          }
        },
        "created-by": {
          "data": {
            "type": "memberships",
            "id": "C7xWERND6yBTpJJVHACzVf"
          }
        },
        "updated-by": {
          "data": {
            "type": "memberships",
            "id": "C7xWERND6yBTpJJVHACzVf"
          }
        }
      }
    }
  ]
}

Create Import Membership
POST`/import-memberships`

Create a new import membership instance.

Example URI

POST https://api.omnigage.io/api/v1/import-memberships

Request

HideShow

Body

{
  "data": {
    "type": "import-memberships",
    "relationships": {
      "upload": {
        "data": {
          "type": "uploads",
          "id": "9kQs8DntN6WUddyZmEqxne"
        }
      }
    }
  }
}

Response 201

HideShow

Body

{
  "data": {
    "id": "THWfEfDcwkgLH674YSGVxq",
    "type": "import-memberships",
    "attributes": {
      "status": "completed",
      "count-created": 27,
      "count-skipped": 0,
      "count-erred": 0,
      "count-total": 27,
      "created-at": "2020-01-01T00:00:00+00:00",
      "updated-at": "2020-01-01T00:00:00+00:00"
    },
    "relationships": {
      "upload": {
        "data": null
      },
      "file": {
        "data": {
          "type": "files",
          "id": "ReN6UbN4zgaWfvFSM8csUZ"
        }
      },
      "results": {
        "links": {
          "related": "/import-memberships/THWfEfDcwkgLH674YSGVxq/results"
        }
      },
      "created-by": {
        "data": {
          "type": "memberships",
          "id": "C7xWERND6yBTpJJVHACzVf"
        }
      },
      "updated-by": {
        "data": {
          "type": "memberships",
          "id": "C7xWERND6yBTpJJVHACzVf"
        }
      }
    }
  }
}

Import Membership ¶

This resource manages retrieving a specified import membership instance.

Retrieve Import Membership
GET`/import-memberships/`

Retrieve an existing import membership instance.

Example URI

GET https://api.omnigage.io/api/v1/import-memberships/

Response 200

HideShow

Body

{
  "data": {
    "id": "THWfEfDcwkgLH674YSGVxq",
    "type": "import-memberships",
    "attributes": {
      "status": "completed",
      "count-created": 27,
      "count-skipped": 0,
      "count-erred": 0,
      "count-total": 27,
      "created-at": "2020-01-01T00:00:00+00:00",
      "updated-at": "2020-01-01T00:00:00+00:00"
    },
    "relationships": {
      "upload": {
        "data": null
      },
      "file": {
        "data": {
          "type": "files",
          "id": "ReN6UbN4zgaWfvFSM8csUZ"
        }
      },
      "results": {
        "links": {
          "related": "/import-memberships/THWfEfDcwkgLH674YSGVxq/results"
        }
      },
      "created-by": {
        "data": {
          "type": "memberships",
          "id": "C7xWERND6yBTpJJVHACzVf"
        }
      },
      "updated-by": {
        "data": {
          "type": "memberships",
          "id": "C7xWERND6yBTpJJVHACzVf"
        }
      }
    }
  }
}

Import Membership Result Collection ¶

This resource manages the retrieval of a given import membership instance’s results collection.

Retrieve Import Membership Results
GET`/import-memberships/results{?include,filter,sort,page}`

Retrieve a collection of membership results.

Example URI

GET https://api.omnigage.io/api/v1/import-memberships/results?include=&filter=1&sort=created-at&page=10

URI Parameters

HideShow

include: string (optional)
Include one ore more related relationships using comma separated name.
sort: string (optional) Example: created-at
Sort on one or more fields using comma separated values.
filter: string (optional) Example: 1
Filter on one or more fields using comma separated values filter[field]=1,2.
page: string (optional) Example: 10
Use page[limit]=10 to reduce the number of instances returned. Use ?page[offset]=10 to skip this many instances.

Response 200

HideShow

Body

{
  "links": {
    "self": "/import-memberships/eYExtt6G7UePgwFirh3DqL/results",
    "next": "/import-memberships/eYExtt6G7UePgwFirh3DqL/results?page[offset]=10",
    "last": "/import-memberships/eYExtt6G7UePgwFirh3DqL/results?page[offset]=100"
  },
  "meta": {
    "total": 1
  },
  "data": [
    {
      "id": "RaF56o2r58hTKT7AYS9doj",
      "type": "import-memberships-results",
      "attributes": {
        "status": "error",
        "reason": "validation",
        "line": 27,
        "message": "Email address is not valid.",
        "created-at": "2020-01-01T00:00:00+00:00",
        "updated-at": "2020-01-01T00:00:00+00:00"
      },
      "relationships": {
        "import-membership": {
          "data": {
            "type": "import-memberships",
            "id": "yu8Y8WBFuGX7ZqMLd5doXT"
          }
        },
        "membership": {
          "data": {
            "type": "memberships",
            "id": "EJW888QJ2kQtGUaASZ8UUm"
          }
        },
        "created-by": {
          "data": {
            "type": "memberships",
            "id": "C7xWERND6yBTpJJVHACzVf"
          }
        },
        "updated-by": {
          "data": {
            "type": "memberships",
            "id": "C7xWERND6yBTpJJVHACzVf"
          }
        }
      }
    }
  ]
}

Import Membership Result ¶

This resource manages retrieving a specified result instance.

Retrieve Import Membership Result
GET`/import-memberships/results/`

Retrieve an existing membership result instance.

Example URI

GET https://api.omnigage.io/api/v1/import-memberships/results/

Response 200

HideShow

Body

{
  "data": {
    "id": "RaF56o2r58hTKT7AYS9doj",
    "type": "import-memberships-results",
    "attributes": {
      "status": "error",
      "reason": "validation",
      "line": 27,
      "message": "Email address is not valid.",
      "created-at": "2020-01-01T00:00:00+00:00",
      "updated-at": "2020-01-01T00:00:00+00:00"
    },
    "relationships": {
      "import-membership": {
        "data": {
          "type": "import-memberships",
          "id": "yu8Y8WBFuGX7ZqMLd5doXT"
        }
      },
      "membership": {
        "data": {
          "type": "memberships",
          "id": "EJW888QJ2kQtGUaASZ8UUm"
        }
      },
      "created-by": {
        "data": {
          "type": "memberships",
          "id": "C7xWERND6yBTpJJVHACzVf"
        }
      },
      "updated-by": {
        "data": {
          "type": "memberships",
          "id": "C7xWERND6yBTpJJVHACzVf"
        }
      }
    }
  }
}

Export Resources ¶

Export Collection ¶

This resource manages the retrieval of export collections and the creation of export instances.

Retrieve Export
GET`/exports{?include,filter,sort,page}`

Retrieve a collection of export.

Example URI

GET https://api.omnigage.io/api/v1/exports?include=&filter=1&sort=created-at&page=10

URI Parameters

HideShow

include: string (optional)
Include one ore more related relationships using comma separated name.
sort: string (optional) Example: created-at
Sort on one or more fields using comma separated values.
filter: string (optional) Example: 1
Filter on one or more fields using comma separated values filter[field]=1,2.
page: string (optional) Example: 10
Use page[limit]=10 to reduce the number of instances returned. Use ?page[offset]=10 to skip this many instances.

Response 200

HideShow

Body

{
  "links": {
    "self": "/exports",
    "next": "/exports?page[offset]=10",
    "last": "/exports?page[offset]=100"
  },
  "meta": {
    "total": 1
  },
  "data": [
    {
      "id": "THWfEfDcwkgLH674YSGVxq",
      "type": "exports",
      "attributes": {
        "status": "completed",
        "kind": "contacts",
        "format": "JSON",
        "start-at": "2020-01-01T00:00:00+00:00",
        "end-at": "2020-01-01T00:00:00+00:00",
        "exclude-ids": false,
        "count-total": 244,
        "count-processed": 244,
        "is-archived": false,
        "created-at": "2020-01-01T00:00:00+00:00",
        "updated-at": "2020-01-01T00:00:00+00:00"
      },
      "relationships": {
        "file": {
          "data": {
            "type": "files",
            "id": "ReN6UbN4zgaWfvFSM8csUZ"
          }
        },
        "created-by": {
          "data": {
            "type": "memberships",
            "id": "C7xWERND6yBTpJJVHACzVf"
          }
        },
        "caller-id": {
          "data": null
        },
        "email-id": {
          "data": null
        },
        "engagement": {
          "data": null
        },
        "list": {
          "data": null
        },
        "phone-number": {
          "data": null
        },
        "updated-by": {
          "data": {
            "type": "memberships",
            "id": "C7xWERND6yBTpJJVHACzVf"
          }
        }
      }
    }
  ]
}

Create Export
POST`/exports`

Create a new export instance.

Note: Ability to create and update exports instances are only permitted if account settings has allow-exports of true.

Example URI

POST https://api.omnigage.io/api/v1/exports

Request

HideShow

Body

{
  "data": {
    "type": "exports",
    "attributes": {
      "kind": "contacts",
      "format": "JSON",
      "start-at": "2020-01-01T00:00:00+00:00",
      "end-at": "2020-01-010T00:00:00+00:00",
      "exclude-ids": false
    },
    "relationships": {
      "list": {
        "data": {
          "type": "lists",
          "id": "C7xWERND6yBTpJJVHACzVf"
        }
      }
    }
  }
}

Response 201

HideShow

Body

{
  "data": {
    "id": "THWfEfDcwkgLH674YSGVxq",
    "type": "exports",
    "attributes": {
      "status": "completed",
      "kind": "contacts",
      "format": "JSON",
      "start-at": "2020-01-01T00:00:00+00:00",
      "end-at": "2020-01-01T00:00:00+00:00",
      "exclude-ids": false,
      "count-total": 244,
      "count-processed": 244,
      "is-archived": false,
      "created-at": "2020-01-01T00:00:00+00:00",
      "updated-at": "2020-01-01T00:00:00+00:00"
    },
    "relationships": {
      "file": {
        "data": {
          "type": "files",
          "id": "ReN6UbN4zgaWfvFSM8csUZ"
        }
      },
      "created-by": {
        "data": {
          "type": "memberships",
          "id": "C7xWERND6yBTpJJVHACzVf"
        }
      },
      "caller-id": {
        "data": null
      },
      "email-id": {
        "data": null
      },
      "engagement": {
        "data": null
      },
      "list": {
        "data": null
      },
      "phone-number": {
        "data": null
      },
      "updated-by": {
        "data": {
          "type": "memberships",
          "id": "C7xWERND6yBTpJJVHACzVf"
        }
      }
    }
  }
}

Export ¶

This resource manages retrieving a specified export instance.

Retrieve Export
GET`/exports/`

Retrieve an existing export instance.

Example URI

GET https://api.omnigage.io/api/v1/exports/

Response 200

HideShow

Body

{
  "data": {
    "id": "THWfEfDcwkgLH674YSGVxq",
    "type": "exports",
    "attributes": {
      "status": "completed",
      "kind": "contacts",
      "format": "JSON",
      "start-at": "2020-01-01T00:00:00+00:00",
      "end-at": "2020-01-01T00:00:00+00:00",
      "exclude-ids": false,
      "count-total": 244,
      "count-processed": 244,
      "is-archived": false,
      "created-at": "2020-01-01T00:00:00+00:00",
      "updated-at": "2020-01-01T00:00:00+00:00"
    },
    "relationships": {
      "file": {
        "data": {
          "type": "files",
          "id": "ReN6UbN4zgaWfvFSM8csUZ"
        }
      },
      "created-by": {
        "data": {
          "type": "memberships",
          "id": "C7xWERND6yBTpJJVHACzVf"
        }
      },
      "caller-id": {
        "data": null
      },
      "email-id": {
        "data": null
      },
      "engagement": {
        "data": null
      },
      "list": {
        "data": null
      },
      "phone-number": {
        "data": null
      },
      "updated-by": {
        "data": {
          "type": "memberships",
          "id": "C7xWERND6yBTpJJVHACzVf"
        }
      }
    }
  }
}

Update Export
PATCH`/exports/`

Update an existing export instance.

The following examples demonstrate:

Updating a pending export. When an export is in a state of pending, the instance can be changed.
Moving the export from a state of pending to queued for processing. Note: Once the export is queued, it can no longer be updated.

Example URI

PATCH https://api.omnigage.io/api/v1/exports/

Request

HideShow

Body

{
  "data": {
    "id": "THWfEfDcwkgLH674YSGVxq",
    "type": "exports",
    "attributes": {
      "status": "pending",
      "kind": "contacts"
    },
    "relationships": {
      "list": {
        "data": {
          "type": "lists",
          "id": "tYz3tcVXh5WGh9nUtjkSwy"
        }
      }
    }
  }
}

Response 202

HideShow

Body

{
  "data": {
    "id": "THWfEfDcwkgLH674YSGVxq",
    "type": "exports",
    "attributes": {
      "status": "completed",
      "kind": "contacts",
      "format": "JSON",
      "start-at": "2020-01-01T00:00:00+00:00",
      "end-at": "2020-01-01T00:00:00+00:00",
      "exclude-ids": false,
      "count-total": 244,
      "count-processed": 244,
      "is-archived": false,
      "created-at": "2020-01-01T00:00:00+00:00",
      "updated-at": "2020-01-01T00:00:00+00:00"
    },
    "relationships": {
      "file": {
        "data": {
          "type": "files",
          "id": "ReN6UbN4zgaWfvFSM8csUZ"
        }
      },
      "created-by": {
        "data": {
          "type": "memberships",
          "id": "C7xWERND6yBTpJJVHACzVf"
        }
      },
      "caller-id": {
        "data": null
      },
      "email-id": {
        "data": null
      },
      "engagement": {
        "data": null
      },
      "list": {
        "data": null
      },
      "phone-number": {
        "data": null
      },
      "updated-by": {
        "data": {
          "type": "memberships",
          "id": "C7xWERND6yBTpJJVHACzVf"
        }
      }
    }
  }
}

Request Processing

HideShow

Body

{
  "data": {
    "id": "THWfEfDcwkgLH674YSGVxq",
    "type": "exports",
    "attributes": {
      "status": "queued"
    }
  }
}

Response 202

HideShow

Body

{
  "data": {
    "id": "THWfEfDcwkgLH674YSGVxq",
    "type": "exports",
    "attributes": {
      "status": "completed",
      "kind": "contacts",
      "format": "JSON",
      "start-at": "2020-01-01T00:00:00+00:00",
      "end-at": "2020-01-01T00:00:00+00:00",
      "exclude-ids": false,
      "count-total": 244,
      "count-processed": 244,
      "is-archived": false,
      "created-at": "2020-01-01T00:00:00+00:00",
      "updated-at": "2020-01-01T00:00:00+00:00"
    },
    "relationships": {
      "file": {
        "data": {
          "type": "files",
          "id": "ReN6UbN4zgaWfvFSM8csUZ"
        }
      },
      "created-by": {
        "data": {
          "type": "memberships",
          "id": "C7xWERND6yBTpJJVHACzVf"
        }
      },
      "caller-id": {
        "data": null
      },
      "email-id": {
        "data": null
      },
      "engagement": {
        "data": null
      },
      "list": {
        "data": null
      },
      "phone-number": {
        "data": null
      },
      "updated-by": {
        "data": {
          "type": "memberships",
          "id": "C7xWERND6yBTpJJVHACzVf"
        }
      }
    }
  }
}

Delete Export
DELETE`/exports/`

Sets the is-archived field’s value to true.

Example URI

DELETE https://api.omnigage.io/api/v1/exports/

Response 204

Administrative Resources ¶

Each of these resources require administrative access except where noted.

Account ¶

This resource manages retrieving and updating a specified account instance.

Retrieve Account
GET`/account`

Retrieve a single account resource.

Note: Any authenticated member can read the account instance.

Example URI

GET https://api.omnigage.io/api/v1/account

Response 200

HideShow

Body

{
    "data": {
        "id": "c8sh5y9hdSMS6zVnrvf53T",
        "type": "accounts",
        "attributes": {
            "name": "Bell Labs"
            "key": "bell-labs",
            "url": "https://bell-labs.omnigage.io",
            "status": 'active',
            "billing-email": "support@omnigage.com",
            "license-seats": 1,
            "license-seats-available": 0,
            "license-seats-used": 1,
            "created-at": "2020-01-01T00:00:00+00:00",
            "updated-at": "2020-01-01T00:00:00+00:00"
        },
        "relationships": {
            "payment-method": {
                "data": {"type": "payment-method", "id": "GpR4FzciuXGZZDirF4B2YV"}
            },
            "plan": {
                "data": {"type": "plans", "id": "Vc8j6m3qbgNecVucvzidW3"}
            }
        }
    }
}

Update Account
PATCH`/account`

Update currently authenticated account instance.

Example URI

PATCH https://api.omnigage.io/api/v1/account

Request

HideShow

Body

{
    "data": {
        "id": "c8sh5y9hdSMS6zVnrvf53T",
        "type": "accounts",
        "attributes": {
            "name": "Bell Labs"
            "key": "bell-labs",
            "url": "https://bell-labs.omnigage.io",
            "status": 'active',
            "billing-email": "support@omnigage.com",
            "license-seats": 1,
            "license-seats-available": 0,
            "license-seats-used": 1,
            "created-at": "2020-01-01T00:00:00+00:00",
            "updated-at": "2020-01-01T00:00:00+00:00"
        },
        "relationships": {
            "payment-method": {
                "data": {"type": "payment-method", "id": "GpR4FzciuXGZZDirF4B2YV"}
            },
            "plan": {
                "data": {"type": "plans", "id": "Vc8j6m3qbgNecVucvzidW3"}
            }
        }
    }
}

Response 202

HideShow

Body

{
    "data": {
        "id": "c8sh5y9hdSMS6zVnrvf53T",
        "type": "accounts",
        "attributes": {
            "name": "Bell Labs"
            "key": "bell-labs",
            "url": "https://bell-labs.omnigage.io",
            "status": 'active',
            "billing-email": "support@omnigage.com",
            "license-seats": 1,
            "license-seats-available": 0,
            "license-seats-used": 1,
            "created-at": "2020-01-01T00:00:00+00:00",
            "updated-at": "2020-01-01T00:00:00+00:00"
        },
        "relationships": {
            "payment-method": {
                "data": {"type": "payment-method", "id": "GpR4FzciuXGZZDirF4B2YV"}
            },
            "plan": {
                "data": {"type": "plans", "id": "Vc8j6m3qbgNecVucvzidW3"}
            }
        }
    }
}

Settings ¶

This resource manages retrieving and updating a specified settings instance.

Retrieve Setting
GET`/settings`

Retrieve an existing setting instance.

Note: Any authenticated member can read the settings instance.

Example URI

GET https://api.omnigage.io/api/v1/settings

Response 200

HideShow

Body

{
  "data": {
    "type": "settings",
    "id": "cu8Eo9RyrUsV4MXEiDZpLM",
    "attributes": {
      "allow-exports": true,
      "enable-audit-logs": true,
      "compliance-is-enabled": true,
      "compliance-type": "pre",
      "compliance-enable-voice": true,
      "compliance-enable-dial": true,
      "compliance-enable-email": true,
      "compliance-enable-text": true,
      "compliance-enable-page": true,
      "compliance-enable-post": true,
      "engagement-enable-voice": true,
      "engagement-enable-dial": true,
      "engagement-enable-email": true,
      "engagement-enable-text": true,
      "meta": {},
      "mfa-is-enabled": true,
      "saml-is-enabled": false,
      "saml-jit-provision-membership-is-enabled": false,
      "saml-idp-sso-url": null,
      "saml-idp-initiated-login-url": null,
      "saml-idp-issuer": null,
      "saml-sp-entity-id": null,
      "saml-sp-acs-url": null,
      "updated-at": "2020-01-01T00:00:00+00:00",
      "created-at": "2020-01-01T00:00:00+00:00"
    },
    "relationships": {
      "saml-idp-certificate": {
        "data": null
      },
      "set-member-status-at-login": {
        "data": {
          "type": "member-statuses",
          "id": "Xm8wckCVFqGkZkzxaDiF7z"
        }
      },
      "set-member-status-at-logout": {
        "data": {
          "type": "member-statuses",
          "id": "zV89r4pThbroSawpASSNnNa"
        }
      },
      "set-member-status-at-call-start": {
        "data": {
          "type": "member-statuses",
          "id": "pkALpDYnKexBFJP9RTUqRp"
        }
      },
      "set-member-status-at-call-finish": {
        "data": {
          "type": "member-statuses",
          "id": "qvEWPjNChLcKwmT3EjK6ZS"
        }
      },
      "set-member-status-at-envelope-preview": {
        "data": {
          "type": "member-statuses",
          "id": "sUZekqWwfqK3Kx3d3gugQN"
        }
      }
    }
  }
}

Update Settings
PATCH`/settings`

Update an existing settings instance.

Example URI

PATCH https://api.omnigage.io/api/v1/settings

Request

HideShow

Body

{
  "data": {
    "type": "settings",
    "id": "cu8Eo9RyrUsV4MXEiDZpLM",
    "attributes": {
      "allow-exports": true,
      "enable-audit-logs": true,
      "compliance-is-enabled": true,
      "compliance-type": "pre",
      "compliance-enable-voice": true,
      "compliance-enable-dial": true,
      "compliance-enable-email": true,
      "compliance-enable-text": true,
      "compliance-enable-page": true,
      "compliance-enable-post": true,
      "engagement-enable-voice": true,
      "engagement-enable-dial": true,
      "engagement-enable-email": true,
      "engagement-enable-text": true,
      "meta": {},
      "mfa-is-enabled": true,
      "saml-is-enabled": false,
      "saml-jit-provision-membership-is-enabled": false,
      "saml-idp-sso-url": null,
      "saml-idp-initiated-login-url": null,
      "saml-idp-issuer": null,
      "saml-sp-entity-id": null,
      "saml-sp-acs-url": null,
      "updated-at": "2020-01-01T00:00:00+00:00",
      "created-at": "2020-01-01T00:00:00+00:00"
    },
    "relationships": {
      "saml-idp-certificate": {
        "data": null
      },
      "set-member-status-at-login": {
        "data": {
          "type": "member-statuses",
          "id": "Xm8wckCVFqGkZkzxaDiF7z"
        }
      },
      "set-member-status-at-logout": {
        "data": {
          "type": "member-statuses",
          "id": "zV89r4pThbroSawpASSNnNa"
        }
      },
      "set-member-status-at-call-start": {
        "data": {
          "type": "member-statuses",
          "id": "pkALpDYnKexBFJP9RTUqRp"
        }
      },
      "set-member-status-at-call-finish": {
        "data": {
          "type": "member-statuses",
          "id": "qvEWPjNChLcKwmT3EjK6ZS"
        }
      },
      "set-member-status-at-envelope-preview": {
        "data": {
          "type": "member-statuses",
          "id": "sUZekqWwfqK3Kx3d3gugQN"
        }
      }
    }
  }
}

Response 202

HideShow

Body

{
  "data": {
    "type": "settings",
    "id": "cu8Eo9RyrUsV4MXEiDZpLM",
    "attributes": {
      "allow-exports": true,
      "enable-audit-logs": true,
      "compliance-is-enabled": true,
      "compliance-type": "pre",
      "compliance-enable-voice": true,
      "compliance-enable-dial": true,
      "compliance-enable-email": true,
      "compliance-enable-text": true,
      "compliance-enable-page": true,
      "compliance-enable-post": true,
      "engagement-enable-voice": true,
      "engagement-enable-dial": true,
      "engagement-enable-email": true,
      "engagement-enable-text": true,
      "meta": {},
      "mfa-is-enabled": true,
      "saml-is-enabled": false,
      "saml-jit-provision-membership-is-enabled": false,
      "saml-idp-sso-url": null,
      "saml-idp-initiated-login-url": null,
      "saml-idp-issuer": null,
      "saml-sp-entity-id": null,
      "saml-sp-acs-url": null,
      "updated-at": "2020-01-01T00:00:00+00:00",
      "created-at": "2020-01-01T00:00:00+00:00"
    },
    "relationships": {
      "saml-idp-certificate": {
        "data": null
      },
      "set-member-status-at-login": {
        "data": {
          "type": "member-statuses",
          "id": "Xm8wckCVFqGkZkzxaDiF7z"
        }
      },
      "set-member-status-at-logout": {
        "data": {
          "type": "member-statuses",
          "id": "zV89r4pThbroSawpASSNnNa"
        }
      },
      "set-member-status-at-call-start": {
        "data": {
          "type": "member-statuses",
          "id": "pkALpDYnKexBFJP9RTUqRp"
        }
      },
      "set-member-status-at-call-finish": {
        "data": {
          "type": "member-statuses",
          "id": "qvEWPjNChLcKwmT3EjK6ZS"
        }
      },
      "set-member-status-at-envelope-preview": {
        "data": {
          "type": "member-statuses",
          "id": "sUZekqWwfqK3Kx3d3gugQN"
        }
      }
    }
  }
}

Member Status Collection ¶

This resource manages the retrieval of status collections and the creation of status instances.

Retrieve Member Status
GET`/member-statuses{?include,filter,sort,page}`

Retrieve a collection of status.

Example URI

GET https://api.omnigage.io/api/v1/member-statuses?include=&filter=1&sort=created-at&page=10

URI Parameters

HideShow

include: string (optional)
Include one ore more related relationships using comma separated name.
sort: string (optional) Example: created-at
Sort on one or more fields using comma separated values.
filter: string (optional) Example: 1
Filter on one or more fields using comma separated values filter[field]=1,2.
page: string (optional) Example: 10
Use page[limit]=10 to reduce the number of instances returned. Use ?page[offset]=10 to skip this many instances.

Response 200

HideShow

Body

{
    "links": {
        "self": "/member-statuses",
        "next": "/member-statuses?page[offset]=10",
        "last": "/member-statuses?page[offset]=100"
    },
    "meta": {
        "total": 11
    },
    "data": [{
        "id": "THWfEfDcwkgLH674YSGVxq",
        "type": "member-statuses",
        "attributes": {
            "label": "Available",
            "kind": "ready"
            "is-archived": false,
            "created-at": "2020-01-01T00:00:00+00:00",
            "updated-at": "2020-01-01T00:00:00+00:00"
        },
        "relationships": {
            "created-by": {
                "data": null
            },
            "updated-by": {
                "data": null
            }
        }
    },
    {
        "id": "THWfEfDcwkgLH674YSGVxq",
        "type": "member-statuses",
        "attributes": {
            "label": "On a Call",
            "kind": "busy"
            "is-archived": false,
            "created-at": "2020-01-01T00:00:00+00:00",
            "updated-at": "2020-01-01T00:00:00+00:00"
        },
        "relationships": {
            "created-by": {
                "data": null
            },
            "updated-by": {
                "data": null
            }
        }
    },
    {
        "id": "THWfEfDcwkgLH674YSGVxq",
        "type": "member-statuses",
        "attributes": {
            "label": "In Meeting",
            "kind": "away"
            "is-archived": false,
            "created-at": "2020-01-01T00:00:00+00:00",
            "updated-at": "2020-01-01T00:00:00+00:00"
        },
        "relationships": {
            "created-by": {
                "data": null
            },
            "updated-by": {
                "data": null
            }
        }
    },
    {
        "id": "THWfEfDcwkgLH674YSGVxq",
        "type": "member-statuses",
        "attributes": {
            "label": "Offline",
            "kind": "offline"
            "is-archived": false,
            "created-at": "2020-01-01T00:00:00+00:00",
            "updated-at": "2020-01-01T00:00:00+00:00"
        },
        "relationships": {
            "created-by": {
                "data": null
            },
            "updated-by": {
                "data": null
            }
        }
    }]
}

Create Member Status
POST`/member-statuses`

Create a new status instance.

Note: Only an account admin can create an instance.

Example URI

POST https://api.omnigage.io/api/v1/member-statuses

Request

HideShow

Body

{
  "data": {
    "type": "member-statuses",
    "attributes": {
      "label": "In Meeting",
      "kind": "away"
    }
  }
}

Response 201

HideShow

Body

{
    "data": {
        "id": "THWfEfDcwkgLH674YSGVxq",
        "type": "member-statuses",
        "attributes": {
            "label": "In Meeting",
            "kind": "away"
            "is-archived": false,
            "created-at": "2020-01-01T00:00:00+00:00",
            "updated-at": "2020-01-01T00:00:00+00:00"
        },
        "relationships": {
            "created-by": {
                "data": {"type": "memberships", "id": "C7xWERND6yBTpJJVHACzVf"}
            },
            "updated-by": {
                "data": {"type": "memberships", "id": "C7xWERND6yBTpJJVHACzVf"}
            }
        }
    }
}

Member Status ¶

This resource manages retrieving a specified status instance.

Retrieve Member Status
GET`/member-statuses/`

Retrieve an existing status instance.

Example URI

GET https://api.omnigage.io/api/v1/member-statuses/

Response 200

HideShow

Body

{
    "data": {
        "id": "THWfEfDcwkgLH674YSGVxq",
        "type": "member-statuses",
        "attributes": {
            "label": "In Meeting",
            "kind": "away"
            "is-archived": false,
            "created-at": "2020-01-01T00:00:00+00:00",
            "updated-at": "2020-01-01T00:00:00+00:00"
        },
        "relationships": {
            "created-by": {
                "data": {"type": "memberships", "id": "C7xWERND6yBTpJJVHACzVf"}
            },
            "updated-by": {
                "data": {"type": "memberships", "id": "C7xWERND6yBTpJJVHACzVf"}
            }
        }
    }
}

Update Member Status
PATCH`/member-statuses/`

Update an existing status instance.

Note: Only an account admin can update an instance.

Example URI

PATCH https://api.omnigage.io/api/v1/member-statuses/

Request

HideShow

Body

{
  "data": {
    "id": "THWfEfDcwkgLH674YSGVxq",
    "type": "member-statuses",
    "attributes": {
      "label": "In Meeting",
      "kind": "away"
    }
  }
}

Response 202

HideShow

Body

{
    "data": {
        "id": "THWfEfDcwkgLH674YSGVxq",
        "type": "member-statuses",
        "attributes": {
            "label": "In Meeting",
            "kind": "away"
            "is-archived": false,
            "created-at": "2020-01-01T00:00:00+00:00",
            "updated-at": "2020-01-01T00:00:00+00:00"
        },
        "relationships": {
            "created-by": {
                "data": {"type": "memberships", "id": "C7xWERND6yBTpJJVHACzVf"}
            },
            "updated-by": {
                "data": {"type": "memberships", "id": "C7xWERND6yBTpJJVHACzVf"}
            }
        }
    }
}

Delete Member Status
DELETE`/member-statuses/`

Sets the is-archived field’s value to true.

Note: Only an account admin can delete an instance.

Example URI

DELETE https://api.omnigage.io/api/v1/member-statuses/

Response 204

Language Collection ¶

This resource manages the retrieval of language collections and the creation of language instances.

Retrieve Languages
GET`/languages{?include,filter,sort,page}`

Retrieve a collection of languages.

Example URI

GET https://api.omnigage.io/api/v1/languages?include=&filter=1&sort=created-at&page=10

URI Parameters

HideShow

include: string (optional)
Include one ore more related relationships using comma separated name.
sort: string (optional) Example: created-at
Sort on one or more fields using comma separated values.
filter: string (optional) Example: 1
Filter on one or more fields using comma separated values filter[field]=1,2.
page: string (optional) Example: 10
Use page[limit]=10 to reduce the number of instances returned. Use ?page[offset]=10 to skip this many instances.

Response 200

HideShow

Body

{
  "links": {
    "self": "/languages",
    "next": "/languages?page[offset]=10",
    "last": "/languages?page[offset]=100"
  },
  "meta": {
    "total": 110
  },
  "data": [
    {
      "id": "RaF56o2r58hTKT7AYS9doj",
      "type": "languages",
      "attributes": {
        "name": "English",
        "code": "en",
        "voice": "Polly-Ivy",
        "unsubscribe-text-is-enabled": true,
        "unsubscribe-text-keywords": [
          "unsubscribe"
        ],
        "unsubscribe-text-append": "Click {{unsubscribe-link}} or respond with \"unsubscribe\" to be removed.",
        "unsubscribe-email-is-enabled": true,
        "unsubscribe-email-keywords": [
          "unsubscribe"
        ],
        "unsubscribe-email-append": "Respond with \"unsubscribe\" to be removed.",
        "is-archived": false,
        "created-at": "2020-01-01T00:00:00+00:00",
        "updated-at": "2020-01-01T00:00:00+00:00"
      },
      "relationships": {
        "created-by": {
          "data": {
            "type": "memberships",
            "id": "wbTFkDBDqnUJkPJwJMwfnh"
          }
        },
        "updated-by": {
          "data": {
            "type": "memberships",
            "id": "wbTFkDBDqnUJkPJwJMwfnh"
          }
        }
      }
    }
  ]
}

Create Language
POST`/languages`

Create a new language instance.

Note: Only permitted by account admins.

Example URI

POST https://api.omnigage.io/api/v1/languages

Request

HideShow

Body

{
  "data": {
    "id": "RaF56o2r58hTKT7AYS9doj",
    "type": "languages",
    "attributes": {
      "name": "English",
      "code": "en",
      "voice": "Polly-Ivy",
      "unsubscribe-text-is-enabled": true,
      "unsubscribe-text-keywords": [
        "unsubscribe"
      ],
      "unsubscribe-text-append": "Click {{unsubscribe-link}} or respond with \"unsubscribe\" to be removed.",
      "unsubscribe-email-is-enabled": true,
      "unsubscribe-email-keywords": [
        "unsubscribe"
      ],
      "unsubscribe-email-append": "Respond with \"unsubscribe\" to be removed.",
      "is-archived": false,
      "created-at": "2020-01-01T00:00:00+00:00",
      "updated-at": "2020-01-01T00:00:00+00:00"
    },
    "relationships": {
      "created-by": {
        "data": {
          "type": "memberships",
          "id": "wbTFkDBDqnUJkPJwJMwfnh"
        }
      },
      "updated-by": {
        "data": {
          "type": "memberships",
          "id": "wbTFkDBDqnUJkPJwJMwfnh"
        }
      }
    }
  }
}

Response 201

HideShow

Body

{
  "data": {
    "id": "RaF56o2r58hTKT7AYS9doj",
    "type": "languages",
    "attributes": {
      "name": "English",
      "code": "en",
      "voice": "Polly-Ivy",
      "unsubscribe-text-is-enabled": true,
      "unsubscribe-text-keywords": [
        "unsubscribe"
      ],
      "unsubscribe-text-append": "Click {{unsubscribe-link}} or respond with \"unsubscribe\" to be removed.",
      "unsubscribe-email-is-enabled": true,
      "unsubscribe-email-keywords": [
        "unsubscribe"
      ],
      "unsubscribe-email-append": "Respond with \"unsubscribe\" to be removed.",
      "is-archived": false,
      "created-at": "2020-01-01T00:00:00+00:00",
      "updated-at": "2020-01-01T00:00:00+00:00"
    },
    "relationships": {
      "created-by": {
        "data": {
          "type": "memberships",
          "id": "wbTFkDBDqnUJkPJwJMwfnh"
        }
      },
      "updated-by": {
        "data": {
          "type": "memberships",
          "id": "wbTFkDBDqnUJkPJwJMwfnh"
        }
      }
    }
  }
}

Language ¶

This resource manages updating and retrieving a specified language instance.

Retrieve Language
GET`/languages/`

Retrieve an existing language instance.

Example URI

GET https://api.omnigage.io/api/v1/languages/

Response 200

HideShow

Body

{
  "data": {
    "id": "RaF56o2r58hTKT7AYS9doj",
    "type": "languages",
    "attributes": {
      "name": "English",
      "code": "en",
      "voice": "Polly-Ivy",
      "unsubscribe-text-is-enabled": true,
      "unsubscribe-text-keywords": [
        "unsubscribe"
      ],
      "unsubscribe-text-append": "Click {{unsubscribe-link}} or respond with \"unsubscribe\" to be removed.",
      "unsubscribe-email-is-enabled": true,
      "unsubscribe-email-keywords": [
        "unsubscribe"
      ],
      "unsubscribe-email-append": "Respond with \"unsubscribe\" to be removed.",
      "is-archived": false,
      "created-at": "2020-01-01T00:00:00+00:00",
      "updated-at": "2020-01-01T00:00:00+00:00"
    },
    "relationships": {
      "created-by": {
        "data": {
          "type": "memberships",
          "id": "wbTFkDBDqnUJkPJwJMwfnh"
        }
      },
      "updated-by": {
        "data": {
          "type": "memberships",
          "id": "wbTFkDBDqnUJkPJwJMwfnh"
        }
      }
    }
  }
}

Update Language
PATCH`/languages/`

Update an existing language instance.

Note: Only permitted by account admins.

Example URI

PATCH https://api.omnigage.io/api/v1/languages/

Request

HideShow

Body

{
  "data": {
    "id": "RaF56o2r58hTKT7AYS9doj",
    "type": "languages",
    "attributes": {
      "name": "English",
      "code": "en",
      "voice": "Polly-Ivy",
      "unsubscribe-text-is-enabled": true,
      "unsubscribe-text-keywords": [
        "unsubscribe"
      ],
      "unsubscribe-text-append": "Click {{unsubscribe-link}} or respond with \"unsubscribe\" to be removed.",
      "unsubscribe-email-is-enabled": true,
      "unsubscribe-email-keywords": [
        "unsubscribe"
      ],
      "unsubscribe-email-append": "Respond with \"unsubscribe\" to be removed.",
      "is-archived": false,
      "created-at": "2020-01-01T00:00:00+00:00",
      "updated-at": "2020-01-01T00:00:00+00:00"
    },
    "relationships": {
      "created-by": {
        "data": {
          "type": "memberships",
          "id": "wbTFkDBDqnUJkPJwJMwfnh"
        }
      },
      "updated-by": {
        "data": {
          "type": "memberships",
          "id": "wbTFkDBDqnUJkPJwJMwfnh"
        }
      }
    }
  }
}

Response 202

HideShow

Body

{
  "data": {
    "id": "RaF56o2r58hTKT7AYS9doj",
    "type": "languages",
    "attributes": {
      "name": "English",
      "code": "en",
      "voice": "Polly-Ivy",
      "unsubscribe-text-is-enabled": true,
      "unsubscribe-text-keywords": [
        "unsubscribe"
      ],
      "unsubscribe-text-append": "Click {{unsubscribe-link}} or respond with \"unsubscribe\" to be removed.",
      "unsubscribe-email-is-enabled": true,
      "unsubscribe-email-keywords": [
        "unsubscribe"
      ],
      "unsubscribe-email-append": "Respond with \"unsubscribe\" to be removed.",
      "is-archived": false,
      "created-at": "2020-01-01T00:00:00+00:00",
      "updated-at": "2020-01-01T00:00:00+00:00"
    },
    "relationships": {
      "created-by": {
        "data": {
          "type": "memberships",
          "id": "wbTFkDBDqnUJkPJwJMwfnh"
        }
      },
      "updated-by": {
        "data": {
          "type": "memberships",
          "id": "wbTFkDBDqnUJkPJwJMwfnh"
        }
      }
    }
  }
}

Delete Language
DELETE`/languages/`

Sets the is-archived field’s value to true.

Note: Only permitted by account admins.

Example URI

DELETE https://api.omnigage.io/api/v1/languages/

Response 204

Tag Collection ¶

This resource manages the retrieval of tag collections and the creation of tag instances.

Retrieve Tags
GET`/tags{?include,filter,sort,page}`

Retrieve a collection of tags.

Example URI

GET https://api.omnigage.io/api/v1/tags?include=&filter=1&sort=created-at&page=10

URI Parameters

HideShow

include: string (optional)
Include one ore more related relationships using comma separated name.
sort: string (optional) Example: created-at
Sort on one or more fields using comma separated values.
filter: string (optional) Example: 1
Filter on one or more fields using comma separated values filter[field]=1,2.
page: string (optional) Example: 10
Use page[limit]=10 to reduce the number of instances returned. Use ?page[offset]=10 to skip this many instances.

Response 200

HideShow

Body

{
  "links": {
    "self": "/tags",
    "next": "/tags?page[offset]=10",
    "last": "/tags?page[offset]=100"
  },
  "meta": {
    "total": 110
  },
  "data": [
    {
      "id": "RaF56o2r58hTKT7AYS9doj",
      "type": "tags",
      "attributes": {
        "name": "marketing",
        "created-at": "2020-01-01T00:00:00+00:00",
        "updated-at": "2020-01-01T00:00:00+00:00"
      },
      "relationships": {
        "created-by": {
          "data": {
            "type": "memberships",
            "id": "wbTFkDBDqnUJkPJwJMwfnh"
          }
        },
        "updated-by": {
          "data": {
            "type": "memberships",
            "id": "wbTFkDBDqnUJkPJwJMwfnh"
          }
        }
      }
    }
  ]
}

Create Tag
POST`/tags`

Create a new tag instance.

Note: Only permitted by account admins.

Example URI

POST https://api.omnigage.io/api/v1/tags

Request

HideShow

Body

{
  "data": {
    "type": "tags",
    "attributes": {
      "name": "marketing"
    }
  }
}

Response 201

HideShow

Body

{
  "data": {
    "id": "RaF56o2r58hTKT7AYS9doj",
    "type": "tags",
    "attributes": {
      "name": "marketing",
      "created-at": "2020-01-01T00:00:00+00:00",
      "updated-at": "2020-01-01T00:00:00+00:00"
    },
    "relationships": {
      "created-by": {
        "data": {
          "type": "memberships",
          "id": "wbTFkDBDqnUJkPJwJMwfnh"
        }
      },
      "updated-by": {
        "data": {
          "type": "memberships",
          "id": "wbTFkDBDqnUJkPJwJMwfnh"
        }
      }
    }
  }
}

Tag ¶

This resource manages updating and retrieving a specified tag instance.

Retrieve Tag
GET`/tags/`

Retrieve an existing tag instance.

Example URI

GET https://api.omnigage.io/api/v1/tags/

Response 200

HideShow

Body

{
  "data": {
    "id": "RaF56o2r58hTKT7AYS9doj",
    "type": "tags",
    "attributes": {
      "name": "marketing",
      "created-at": "2020-01-01T00:00:00+00:00",
      "updated-at": "2020-01-01T00:00:00+00:00"
    },
    "relationships": {
      "created-by": {
        "data": {
          "type": "memberships",
          "id": "wbTFkDBDqnUJkPJwJMwfnh"
        }
      },
      "updated-by": {
        "data": {
          "type": "memberships",
          "id": "wbTFkDBDqnUJkPJwJMwfnh"
        }
      }
    }
  }
}

Update Tag
PATCH`/tags/`

Update an existing tag instance.

Note: Only permitted by account admins.

Example URI

PATCH https://api.omnigage.io/api/v1/tags/

Request

HideShow

Body

{
  "data": {
    "id": "RaF56o2r58hTKT7AYS9doj",
    "type": "tags",
    "attributes": {
      "name": "marketing",
      "created-at": "2020-01-01T00:00:00+00:00",
      "updated-at": "2020-01-01T00:00:00+00:00"
    },
    "relationships": {
      "created-by": {
        "data": {
          "type": "memberships",
          "id": "wbTFkDBDqnUJkPJwJMwfnh"
        }
      },
      "updated-by": {
        "data": {
          "type": "memberships",
          "id": "wbTFkDBDqnUJkPJwJMwfnh"
        }
      }
    }
  }
}

Response 202

HideShow

Body

{
  "data": {
    "id": "RaF56o2r58hTKT7AYS9doj",
    "type": "tags",
    "attributes": {
      "name": "marketing",
      "created-at": "2020-01-01T00:00:00+00:00",
      "updated-at": "2020-01-01T00:00:00+00:00"
    },
    "relationships": {
      "created-by": {
        "data": {
          "type": "memberships",
          "id": "wbTFkDBDqnUJkPJwJMwfnh"
        }
      },
      "updated-by": {
        "data": {
          "type": "memberships",
          "id": "wbTFkDBDqnUJkPJwJMwfnh"
        }
      }
    }
  }
}

Delete Tag
DELETE`/tags/`

Deleting a tag will remove any previous relationship referencing it as well.

Note: Only permitted by account admins.

Example URI

DELETE https://api.omnigage.io/api/v1/tags/

Response 204

Membership Collection ¶

This resource manages account access.

Retrieve Memberships
GET`/memberships{?include,filter,sort,page}`

Retrieve a collection of memberships.

Example URI

GET https://api.omnigage.io/api/v1/memberships?include=&filter=1&sort=created-at&page=10

URI Parameters

HideShow

include: string (optional)
Include one ore more related relationships using comma separated name.
sort: string (optional) Example: created-at
Sort on one or more fields using comma separated values.
filter: string (optional) Example: 1
Filter on one or more fields using comma separated values filter[field]=1,2.
page: string (optional) Example: 10
Use page[limit]=10 to reduce the number of instances returned. Use ?page[offset]=10 to skip this many instances.

Response 200

HideShow

Body

{
  "links": {
    "self": "/memberships",
    "next": "/memberships?page[offset]=10",
    "last": "/memberships?page[offset]=100"
  },
  "meta": {
    "total": 110
  },
  "data": [
    {
      "id": "wpsWLdLt9nscn2jbTD3uxe",
      "type": "memberships",
      "attributes": {
        "first-name": "Alexander",
        "last-name": "Bell",
        "email-address": "alexander.bell@bell-labs.com",
        "default-masked-phone-number": null,
        "is-accepted": true,
        "is-account-admin": false,
        "is-compliance-admin": false,
        "is-compliance-notification-enabled": false,
        "is-compliance-notification-text-enabled": false,
        "is-compliance-notification-email-enabled": false,
        "is-archived": false,
        "member-status-updated-at": "2020-01-01T00:00:00+00:00",
        "created-at": "2020-01-01T00:00:00+00:00",
        "updated-at": "2020-01-01T00:00:00+00:00",
        "deleted-at": null
      },
      "relationships": {
        "member-status": {
          "data": {
            "type": "member-statuses",
            "id": "Zd4dJXrbk4cLDiLcuEL3Kd"
          }
        },
        "user": {
          "data": {
            "type": "users",
            "id": "c8sh5y9hdSMS6zVnrvf53T"
          }
        },
        "picture": {
          "data": {
            "type": "pictures",
            "id": "AuEo9RyrUsV4MXEiDZpLM"
          }
        },
        "caller-id": {
          "data": {
            "type": "caller-ids",
            "id": "jR7uSB8JYWzfXfkp8CyVeV"
          }
        },
        "email-id": {
          "data": {
            "type": "email-ids",
            "id": "J6DHiRVAhZ5Ji5DARZam4Z"
          }
        },
        "phone-number": {
          "data": {
            "type": "phone-numbers",
            "id": "jbPAifRrHj2RZZCd79k9HA"
          }
        },
        "created-by": {
          "data": {
            "type": "memberships",
            "id": "C7xWERND6yBTpJJVHACzVf"
          }
        },
        "updated-by": {
          "data": {
            "type": "memberships",
            "id": "C7xWERND6yBTpJJVHACzVf"
          }
        },
        "deleted-by": {
          "data": null
        }
      }
    }
  ]
}

Create Membership
POST`/memberships`

Create a new membership instance.

Note the following business logic:

If the associated email-address does not exist on the platform, an invite email will include a link to sign up.
If the email-address is bound to a user, the email will simply link to login to accept the membership.
For the membership to be visible for the user, the associated email address must be confirmed.

Note: Memberships can only be created by account admins.

Example URI

POST https://api.omnigage.io/api/v1/memberships

Request

HideShow

Body

{
  "data": {
    "type": "memberships",
    "attributes": {
      "first-name": "Alexander",
      "last-name": "Bell",
      "email-address": "alexander.bell@bell-labs.com"
    }
  }
}

Response 201

HideShow

Body

{
  "data": {
    "id": "wpsWLdLt9nscn2jbTD3uxe",
    "type": "memberships",
    "attributes": {
      "first-name": "Alexander",
      "last-name": "Bell",
      "email-address": "alexander.bell@bell-labs.com",
      "default-masked-phone-number": null,
      "is-accepted": true,
      "is-account-admin": false,
      "is-compliance-admin": false,
      "is-compliance-notification-enabled": false,
      "is-compliance-notification-text-enabled": false,
      "is-compliance-notification-email-enabled": false,
      "is-archived": false,
      "member-status-updated-at": "2020-01-01T00:00:00+00:00",
      "created-at": "2020-01-01T00:00:00+00:00",
      "updated-at": "2020-01-01T00:00:00+00:00",
      "deleted-at": null
    },
    "relationships": {
      "member-status": {
        "data": {
          "type": "member-statuses",
          "id": "Zd4dJXrbk4cLDiLcuEL3Kd"
        }
      },
      "user": {
        "data": {
          "type": "users",
          "id": "c8sh5y9hdSMS6zVnrvf53T"
        }
      },
      "picture": {
        "data": {
          "type": "pictures",
          "id": "AuEo9RyrUsV4MXEiDZpLM"
        }
      },
      "caller-id": {
        "data": {
          "type": "caller-ids",
          "id": "jR7uSB8JYWzfXfkp8CyVeV"
        }
      },
      "email-id": {
        "data": {
          "type": "email-ids",
          "id": "J6DHiRVAhZ5Ji5DARZam4Z"
        }
      },
      "phone-number": {
        "data": {
          "type": "phone-numbers",
          "id": "jbPAifRrHj2RZZCd79k9HA"
        }
      },
      "created-by": {
        "data": {
          "type": "memberships",
          "id": "C7xWERND6yBTpJJVHACzVf"
        }
      },
      "updated-by": {
        "data": {
          "type": "memberships",
          "id": "C7xWERND6yBTpJJVHACzVf"
        }
      },
      "deleted-by": {
        "data": null
      }
    }
  }
}

Membership ¶

This resource manages retrieving, updating and removing a specified membership instance.

Retrieve Membership
GET`/memberships/`

Retrieve an existing membership instance.

Example URI

GET https://api.omnigage.io/api/v1/memberships/

Response 200

HideShow

Body

{
  "data": {
    "id": "wpsWLdLt9nscn2jbTD3uxe",
    "type": "memberships",
    "attributes": {
      "first-name": "Alexander",
      "last-name": "Bell",
      "email-address": "alexander.bell@bell-labs.com",
      "default-masked-phone-number": null,
      "is-accepted": true,
      "is-account-admin": false,
      "is-compliance-admin": false,
      "is-compliance-notification-enabled": false,
      "is-compliance-notification-text-enabled": false,
      "is-compliance-notification-email-enabled": false,
      "is-archived": false,
      "member-status-updated-at": "2020-01-01T00:00:00+00:00",
      "created-at": "2020-01-01T00:00:00+00:00",
      "updated-at": "2020-01-01T00:00:00+00:00",
      "deleted-at": null
    },
    "relationships": {
      "member-status": {
        "data": {
          "type": "member-statuses",
          "id": "Zd4dJXrbk4cLDiLcuEL3Kd"
        }
      },
      "user": {
        "data": {
          "type": "users",
          "id": "c8sh5y9hdSMS6zVnrvf53T"
        }
      },
      "picture": {
        "data": {
          "type": "pictures",
          "id": "AuEo9RyrUsV4MXEiDZpLM"
        }
      },
      "caller-id": {
        "data": {
          "type": "caller-ids",
          "id": "jR7uSB8JYWzfXfkp8CyVeV"
        }
      },
      "email-id": {
        "data": {
          "type": "email-ids",
          "id": "J6DHiRVAhZ5Ji5DARZam4Z"
        }
      },
      "phone-number": {
        "data": {
          "type": "phone-numbers",
          "id": "jbPAifRrHj2RZZCd79k9HA"
        }
      },
      "created-by": {
        "data": {
          "type": "memberships",
          "id": "C7xWERND6yBTpJJVHACzVf"
        }
      },
      "updated-by": {
        "data": {
          "type": "memberships",
          "id": "C7xWERND6yBTpJJVHACzVf"
        }
      },
      "deleted-by": {
        "data": null
      }
    }
  }
}

Update Membership
PATCH`/memberships/`

Update an existing membership instance.

Note: Memberships can only be edited by account admins or the membership itself.

Example URI

PATCH https://api.omnigage.io/api/v1/memberships/

Request

HideShow

Body

{
  "data": {
    "id": "wpsWLdLt9nscn2jbTD3uxe",
    "type": "memberships",
    "attributes": {
      "default-masked-phone-number": "+14071231234"
    },
    "relationships": {
      "caller-id": {
        "data": {
          "type": "caller-ids",
          "id": "jR7uSB8JYWzfXfkp8CyVeV"
        }
      },
      "email-id": {
        "data": {
          "type": "email-ids",
          "id": "J6DHiRVAhZ5Ji5DARZam4Z"
        }
      },
      "phone-number": {
        "data": {
          "type": "phone-numbers",
          "id": "jbPAifRrHj2RZZCd79k9HA"
        }
      }
    }
  }
}

Response 202

HideShow

Body

{
  "data": {
    "id": "wpsWLdLt9nscn2jbTD3uxe",
    "type": "memberships",
    "attributes": {
      "first-name": "Alexander",
      "last-name": "Bell",
      "email-address": "alexander.bell@bell-labs.com",
      "default-masked-phone-number": null,
      "is-accepted": true,
      "is-account-admin": false,
      "is-compliance-admin": false,
      "is-compliance-notification-enabled": false,
      "is-compliance-notification-text-enabled": false,
      "is-compliance-notification-email-enabled": false,
      "is-archived": false,
      "member-status-updated-at": "2020-01-01T00:00:00+00:00",
      "created-at": "2020-01-01T00:00:00+00:00",
      "updated-at": "2020-01-01T00:00:00+00:00",
      "deleted-at": null
    },
    "relationships": {
      "member-status": {
        "data": {
          "type": "member-statuses",
          "id": "Zd4dJXrbk4cLDiLcuEL3Kd"
        }
      },
      "user": {
        "data": {
          "type": "users",
          "id": "c8sh5y9hdSMS6zVnrvf53T"
        }
      },
      "picture": {
        "data": {
          "type": "pictures",
          "id": "AuEo9RyrUsV4MXEiDZpLM"
        }
      },
      "caller-id": {
        "data": {
          "type": "caller-ids",
          "id": "jR7uSB8JYWzfXfkp8CyVeV"
        }
      },
      "email-id": {
        "data": {
          "type": "email-ids",
          "id": "J6DHiRVAhZ5Ji5DARZam4Z"
        }
      },
      "phone-number": {
        "data": {
          "type": "phone-numbers",
          "id": "jbPAifRrHj2RZZCd79k9HA"
        }
      },
      "created-by": {
        "data": {
          "type": "memberships",
          "id": "C7xWERND6yBTpJJVHACzVf"
        }
      },
      "updated-by": {
        "data": {
          "type": "memberships",
          "id": "C7xWERND6yBTpJJVHACzVf"
        }
      },
      "deleted-by": {
        "data": null
      }
    }
  }
}

Delete Membership
DELETE`/memberships/`

Sets the is-archived field’s value to true.

Example URI

DELETE https://api.omnigage.io/api/v1/memberships/

Response 204

Email Domain Collection ¶

This resource provides querying of the email domains collection along with the creation of email domain instances.

Retrieve Email Domain
GET`/email-domains{?include,filter,sort,page}`

Retrieve a collection of email domains.

Example URI

GET https://api.omnigage.io/api/v1/email-domains?include=&filter=1&sort=created-at&page=10

URI Parameters

HideShow

include: string (optional)
Include one ore more related relationships using comma separated name.
sort: string (optional) Example: created-at
Sort on one or more fields using comma separated values.
filter: string (optional) Example: 1
Filter on one or more fields using comma separated values filter[field]=1,2.
page: string (optional) Example: 10
Use page[limit]=10 to reduce the number of instances returned. Use ?page[offset]=10 to skip this many instances.

Response 200

HideShow

Body

{
  "links": {
    "self": "/email-domains",
    "next": "/email-domains?page[offset]=10",
    "last": "/email-domains?page[offset]=100"
  },
  "meta": {
    "total": 10
  },
  "data": [
    {
      "id": "cXEm7dHihzTjMbuPgzqNiP",
      "type": "email-domains",
      "attributes": {
        "domain": "bell-labs.com",
        "status": "pending",
        "verification-token": "YPue2HNaOkJF8Xl16FigqKBQzf3Ofl1K",
        "created-at": "2020-01-01T00:00:00+00:00",
        "updated-at": "2020-01-01T00:00:00+00:00"
      },
      "relationships": {
        "created-by": {
          "data": {
            "type": "memberships",
            "id": "C7xWERND6yBTpJJVHACzVf"
          }
        },
        "updated-by": {
          "data": {
            "type": "memberships",
            "id": "C7xWERND6yBTpJJVHACzVf"
          }
        }
      }
    }
  ]
}

Create Email Domain
POST`/email-domains`

Create a new email domains instance.

Example URI

POST https://api.omnigage.io/api/v1/email-domains

Request

HideShow

Body

{
  "data": {
    "type": "email-domains",
    "attributes": {
      "domain": "bell-labs.com"
    }
  }
}

Response 201

HideShow

Body

{
    "data": {
        "id": "cXEm7dHihzTjMbuPgzqNiP",
        "type": "email-domains",
        "attributes": {
            "domain": "bell-labs.com",,
            "verification-token": "YPue2HNaOkJF8Xl16FigqKBQzf3Ofl1K",
            "status": "pending",
            "created-at": "2020-01-01T00:00:00+00:00",
            "updated-at": "2020-01-01T00:00:00+00:00"
        },
        "relationships": {
            "created-by": {
                "data": {"type": "memberships", "id": "C7xWERND6yBTpJJVHACzVf"}
            },
            "updated-by": {
                "data": {"type": "memberships", "id": "C7xWERND6yBTpJJVHACzVf"}
            }
        }
    }
}

Email Domain ¶

This resource manages retrieving and deleting a specified email domain instance.

Retrieve Email Domain
GET`/email-domains/`

Retrieve an existing email domains instance.

Example URI

GET https://api.omnigage.io/api/v1/email-domains/

Response 200

HideShow

Body

{
    "data": {
        "id": "cXEm7dHihzTjMbuPgzqNiP",
        "type": "email-domains",
        "attributes": {
            "domain": "bell-labs.com",,
            "verification-token": "YPue2HNaOkJF8Xl16FigqKBQzf3Ofl1K",
            "status": "pending",
            "created-at": "2020-01-01T00:00:00+00:00",
            "updated-at": "2020-01-01T00:00:00+00:00"
        },
        "relationships": {
            "created-by": {
                "data": {"type": "memberships", "id": "C7xWERND6yBTpJJVHACzVf"}
            },
            "updated-by": {
                "data": {"type": "memberships", "id": "C7xWERND6yBTpJJVHACzVf"}
            }
        }
    }
}

Delete Email Domain
DELETE`/email-domains/`

Delete an existing email domains instance.

Example URI

DELETE https://api.omnigage.io/api/v1/email-domains/

Response 204

Email Domain DKIM Collection ¶

This resource provides querying of the email domain DKIMs collection along with the creation of email domain DKIM instances.

Retrieve Email Domain DKIM
GET`/email-domain-dkims{?include,filter,sort,page}`

Retrieve a collection of email domain DKIMs.

Example URI

GET https://api.omnigage.io/api/v1/email-domain-dkims?include=&filter=1&sort=created-at&page=10

URI Parameters

HideShow

include: string (optional)
Include one ore more related relationships using comma separated name.
sort: string (optional) Example: created-at
Sort on one or more fields using comma separated values.
filter: string (optional) Example: 1
Filter on one or more fields using comma separated values filter[field]=1,2.
page: string (optional) Example: 10
Use page[limit]=10 to reduce the number of instances returned. Use ?page[offset]=10 to skip this many instances.

Response 200

HideShow

Body

{
  "links": {
    "self": "/email-domain-dkims",
    "next": "/email-domain-dkims?page[offset]=10",
    "last": "/email-domain-dkims?page[offset]=100"
  },
  "meta": {
    "total": 10
  },
  "data": [
    {
      "id": "cXEm7dHihzTjMbuPgzqNiP",
      "type": "email-domain-dkims",
      "attributes": {
        "domain": "bell-labs.com",
        "status": "pending",
        "tokens": [
          {
            "u8rGLW2FLGUM._domainkey.bell-labs.com": "p2TqPsTDFnL.dkim.omnigage.io"
          },
          {
            "YTzVz2QzAJKO._domainkey.bell-labs.com": "wTsKSHUt78B.dkim.omnigage.io"
          },
          {
            "RzrQy9YM1CIb._domainkey.bell-labs.com": "q1WKjIlCXOf.dkim.omnigage.io"
          }
        ],
        "created-at": "2020-01-01T00:00:00+00:00",
        "updated-at": "2020-01-01T00:00:00+00:00"
      },
      "relationships": {
        "created-by": {
          "data": {
            "type": "memberships",
            "id": "C7xWERND6yBTpJJVHACzVf"
          }
        },
        "updated-by": {
          "data": {
            "type": "memberships",
            "id": "C7xWERND6yBTpJJVHACzVf"
          }
        }
      }
    }
  ]
}

Create Email Domain DKIM
POST`/email-domain-dkims`

Create a new email domain DKIMs instance.

Example URI

POST https://api.omnigage.io/api/v1/email-domain-dkims

Request

HideShow

Body

{
  "data": {
    "type": "email-domain-dkims",
    "attributes": {
      "domain": "bell-labs.com"
    }
  }
}

Response 201

HideShow

Body

{
  "data": {
    "id": "cXEm7dHihzTjMbuPgzqNiP",
    "type": "email-domain-dkims",
    "attributes": {
      "domain": "bell-labs.com",
      "status": "pending",
      "tokens": [
        {
          "u8rGLW2FLGUM._domainkey.bell-labs.com": "p2TqPsTDFnL.dkim.omnigage.io"
        },
        {
          "YTzVz2QzAJKO._domainkey.bell-labs.com": "wTsKSHUt78B.dkim.omnigage.io"
        },
        {
          "RzrQy9YM1CIb._domainkey.bell-labs.com": "q1WKjIlCXOf.dkim.omnigage.io"
        }
      ],
      "created-at": "2020-01-01T00:00:00+00:00",
      "updated-at": "2020-01-01T00:00:00+00:00"
    },
    "relationships": {
      "created-by": {
        "data": {
          "type": "memberships",
          "id": "C7xWERND6yBTpJJVHACzVf"
        }
      },
      "updated-by": {
        "data": {
          "type": "memberships",
          "id": "C7xWERND6yBTpJJVHACzVf"
        }
      }
    }
  }
}

Email Domain DKIM ¶

This resource manages retrieving and deleting a specified email domain DKIM instance.

Retrieve Email Domain DKIM
GET`/email-domain-dkims/`

Retrieve an existing email domain DKIMs instance.

Example URI

GET https://api.omnigage.io/api/v1/email-domain-dkims/

Response 200

HideShow

Body

{
  "data": {
    "id": "cXEm7dHihzTjMbuPgzqNiP",
    "type": "email-domain-dkims",
    "attributes": {
      "domain": "bell-labs.com",
      "status": "pending",
      "tokens": [
        {
          "u8rGLW2FLGUM._domainkey.bell-labs.com": "p2TqPsTDFnL.dkim.omnigage.io"
        },
        {
          "YTzVz2QzAJKO._domainkey.bell-labs.com": "wTsKSHUt78B.dkim.omnigage.io"
        },
        {
          "RzrQy9YM1CIb._domainkey.bell-labs.com": "q1WKjIlCXOf.dkim.omnigage.io"
        }
      ],
      "created-at": "2020-01-01T00:00:00+00:00",
      "updated-at": "2020-01-01T00:00:00+00:00"
    },
    "relationships": {
      "created-by": {
        "data": {
          "type": "memberships",
          "id": "C7xWERND6yBTpJJVHACzVf"
        }
      },
      "updated-by": {
        "data": {
          "type": "memberships",
          "id": "C7xWERND6yBTpJJVHACzVf"
        }
      }
    }
  }
}

Delete Email Domain DKIM
DELETE`/email-domain-dkims/`

Delete an existing email domain DKIMs instance.

Example URI

DELETE https://api.omnigage.io/api/v1/email-domain-dkims/

Response 204

Audit Log Collection ¶

This resource provides querying of the audit logs collection.

Note: Only accessible by account admins.

Retrieve Audit Log
GET`/audit-logs{?include,filter,sort,page}`

Retrieve a collection of audit logs.

Example URI

GET https://api.omnigage.io/api/v1/audit-logs?include=&filter=1&sort=created-at&page=10

URI Parameters

HideShow

include: string (optional)
Include one ore more related relationships using comma separated name.
sort: string (optional) Example: created-at
Sort on one or more fields using comma separated values.
filter: string (optional) Example: 1
Filter on one or more fields using comma separated values filter[field]=1,2.
page: string (optional) Example: 10
Use page[limit]=10 to reduce the number of instances returned. Use ?page[offset]=10 to skip this many instances.

Response 200

HideShow

Body

{
  "links": {
    "self": "/audit-logs",
    "next": "/audit-logs?page[offset]=10",
    "last": "/audit-logs?page[offset]=100"
  },
  "meta": {
    "total": 10
  },
  "data": [
    {
      "id": "cXEm7dHihzTjMbuPgzqNiP",
      "type": "audit-logs",
      "attributes": {
        "kind": "create",
        "resource": "engagements",
        "description": "Alexander Bell created an engagement",
        "created-at": "2020-01-01T00:00:00+00:00"
      },
      "relationships": {
        "membership": {
          "data": {
            "type": "memberships",
            "id": "C7xWERND6yBTpJJVHACzVf"
          }
        },
        "related": {
          "data": {
            "type": "engagements",
            "id": "THWfEfDcwkgLH674YSGVxq"
          }
        }
      }
    }
  ]
}

Audit Log ¶

This resource manages retrieving a specified audit log instance.

Retrieve Audit Log
GET`/audit-logs/`

Retrieve an existing audit logs instance.

Example URI

GET https://api.omnigage.io/api/v1/audit-logs/

Response 200

HideShow

Body

{
  "data": {
    "id": "cXEm7dHihzTjMbuPgzqNiP",
    "type": "audit-logs",
    "attributes": {
      "kind": "create",
      "resource": "engagements",
      "description": "Alexander Bell created an engagement",
      "created-at": "2020-01-01T00:00:00+00:00"
    },
    "relationships": {
      "membership": {
        "data": {
          "type": "memberships",
          "id": "C7xWERND6yBTpJJVHACzVf"
        }
      },
      "related": {
        "data": {
          "type": "engagements",
          "id": "THWfEfDcwkgLH674YSGVxq"
        }
      }
    }
  }
}

Service Profile Collection ¶

This resource manages the retrieval and the creation of service profile instances.

Retrieve Service Profiles
GET`/service-profiles{?include,filter,sort,page}`

Retrieve a collection of service profiles.

Example URI

GET https://api.omnigage.io/api/v1/service-profiles?include=&filter=1&sort=created-at&page=10

URI Parameters

HideShow

include: string (optional)
Include one ore more related relationships using comma separated name.
sort: string (optional) Example: created-at
Sort on one or more fields using comma separated values.
filter: string (optional) Example: 1
Filter on one or more fields using comma separated values filter[field]=1,2.
page: string (optional) Example: 10
Use page[limit]=10 to reduce the number of instances returned. Use ?page[offset]=10 to skip this many instances.

Response 200

HideShow

Body

{
  "links": {
    "self": "/service-profiles",
    "next": "/service-profiles?page[offset]=10",
    "last": "/service-profiles?page[offset]=100"
  },
  "meta": {
    "total": 10
  },
  "data": [
    {
      "id": "RaF56o2r58hTKT7AYS9doj",
      "type": "service-profiles",
      "attributes": {
        "label": "London Office",
        "kind": "telnyx",
        "connection-auth-token": null,
        "connection-callback-secret": null,
        "connection-callback-url": null,
        "connection-context-id": "8217869836325902",
        "default-caller-id": "+11234567890",
        "is-caller-id-enabled": true,
        "is-purchasable-phone-number-enabled": true,
        "is-enabled": true,
        "is-default": true,
        "is-archived": false,
        "created-at": "2020-01-01T00:00:00+00:00",
        "updated-at": "2020-01-01T00:00:00+00:00"
      },
      "relationships": {
        "created-by": {
          "data": {
            "type": "memberships",
            "id": "C7xWERND6yBTpJJVHACzVf"
          }
        },
        "updated-by": {
          "data": {
            "type": "memberships",
            "id": "C7xWERND6yBTpJJVHACzVf"
          }
        }
      }
    }
  ]
}

Create Service Profile
POST`/service-profiles`

Create a new service profile instance.

Example URI

POST https://api.omnigage.io/api/v1/service-profiles

Request

HideShow

Body

{
  "data": {
    "id": "RaF56o2r58hTKT7AYS9doj",
    "type": "service-profiles",
    "attributes": {
      "label": "London Office",
      "kind": "telnyx",
      "connection-auth-token": "MgVCTKlL(fsl2[n5YS%PB0X[f",
      "connection-callback-secret": "58wI1KRApf6m0ammdLWWYyuAW",
      "connection-context-id": "8217869836325902",
      "default-caller-id": "+11234567890",
      "is-caller-id-enabled": true,
      "is-purchasable-phone-number-enabled": true,
      "is-enabled": true
    }
  }
}

Response 201

HideShow

Body

{
  "data": {
    "id": "RaF56o2r58hTKT7AYS9doj",
    "type": "service-profiles",
    "attributes": {
      "label": "London Office",
      "kind": "telnyx",
      "connection-auth-token": null,
      "connection-callback-secret": null,
      "connection-callback-url": "https://api.omnigage.com/callbacks/RaF56o2r58hTKT7AYS9doj/58wI1KRApf6m0ammdLWWYyuAW",
      "connection-context-id": "8217869836325902",
      "default-caller-id": "+11234567890",
      "is-caller-id-enabled": true,
      "is-purchasable-phone-number-enabled": true,
      "is-enabled": true,
      "is-default": true,
      "is-archived": false,
      "created-at": "2020-01-01T00:00:00+00:00",
      "updated-at": "2020-01-01T00:00:00+00:00"
    },
    "relationships": {
      "created-by": {
        "data": {
          "type": "memberships",
          "id": "C7xWERND6yBTpJJVHACzVf"
        }
      },
      "updated-by": {
        "data": {
          "type": "memberships",
          "id": "C7xWERND6yBTpJJVHACzVf"
        }
      }
    }
  }
}

Service Profile ¶

This resource manages updating and retrieving a specified service profile instance.

Retrieve Service Profile
GET`/service-profiles/`

Retrieve an existing service profile instance.

Example URI

GET https://api.omnigage.io/api/v1/service-profiles/

Response 200

HideShow

Body

{
  "data": {
    "id": "RaF56o2r58hTKT7AYS9doj",
    "type": "service-profiles",
    "attributes": {
      "label": "London Office",
      "kind": "telnyx",
      "connection-auth-token": null,
      "connection-callback-secret": null,
      "connection-callback-url": null,
      "connection-context-id": "8217869836325902",
      "default-caller-id": "+11234567890",
      "is-caller-id-enabled": true,
      "is-purchasable-phone-number-enabled": true,
      "is-enabled": true,
      "is-default": true,
      "is-archived": false,
      "created-at": "2020-01-01T00:00:00+00:00",
      "updated-at": "2020-01-01T00:00:00+00:00"
    },
    "relationships": {
      "created-by": {
        "data": {
          "type": "memberships",
          "id": "C7xWERND6yBTpJJVHACzVf"
        }
      },
      "updated-by": {
        "data": {
          "type": "memberships",
          "id": "C7xWERND6yBTpJJVHACzVf"
        }
      }
    }
  }
}

Update Service Profile
PATCH`/service-profiles/`

Update an existing service profile instance.

Example URI

PATCH https://api.omnigage.io/api/v1/service-profiles/

Request

HideShow

Body

{
  "data": {
    "id": "RaF56o2r58hTKT7AYS9doj",
    "type": "service-profiles",
    "attributes": {
      "label": "London Office",
      "kind": "telnyx",
      "connection-auth-token": null,
      "connection-callback-secret": null,
      "connection-callback-url": null,
      "connection-context-id": "8217869836325902",
      "default-caller-id": "+11234567890",
      "is-caller-id-enabled": true,
      "is-purchasable-phone-number-enabled": true,
      "is-enabled": true,
      "is-default": true,
      "is-archived": false,
      "created-at": "2020-01-01T00:00:00+00:00",
      "updated-at": "2020-01-01T00:00:00+00:00"
    },
    "relationships": {
      "created-by": {
        "data": {
          "type": "memberships",
          "id": "C7xWERND6yBTpJJVHACzVf"
        }
      },
      "updated-by": {
        "data": {
          "type": "memberships",
          "id": "C7xWERND6yBTpJJVHACzVf"
        }
      }
    }
  }
}

Response 202

HideShow

Body

{
  "data": {
    "id": "RaF56o2r58hTKT7AYS9doj",
    "type": "service-profiles",
    "attributes": {
      "label": "London Office",
      "kind": "telnyx",
      "connection-auth-token": null,
      "connection-callback-secret": null,
      "connection-callback-url": null,
      "connection-context-id": "8217869836325902",
      "default-caller-id": "+11234567890",
      "is-caller-id-enabled": true,
      "is-purchasable-phone-number-enabled": true,
      "is-enabled": true,
      "is-default": true,
      "is-archived": false,
      "created-at": "2020-01-01T00:00:00+00:00",
      "updated-at": "2020-01-01T00:00:00+00:00"
    },
    "relationships": {
      "created-by": {
        "data": {
          "type": "memberships",
          "id": "C7xWERND6yBTpJJVHACzVf"
        }
      },
      "updated-by": {
        "data": {
          "type": "memberships",
          "id": "C7xWERND6yBTpJJVHACzVf"
        }
      }
    }
  }
}

Delete Service Profile
DELETE`/service-profiles/`

Sets the is-archived field’s value to true. Note: The actual instance is not deleted.

Example URI

DELETE https://api.omnigage.io/api/v1/service-profiles/

Response 204

Compliance Resources ¶

Note: These resources read and write abilities are restricted as follows:

Ability to read and write based on whether a membership has is-compliance-admin of true.
If membership has collaborator entry for related kind. For example, to read a review for an engagement, the membership must have a collaborator instance for the engagement and the instance must have at least read ability.

Review Collection ¶

This resource manages the retrieval of review collections.

Retrieve Reviews
GET`/reviews{?include,filter,sort,page}`

Retrieve a collection of reviews.

Example URI

GET https://api.omnigage.io/api/v1/reviews?include=&filter=1&sort=created-at&page=10

URI Parameters

HideShow

include: string (optional)
Include one ore more related relationships using comma separated name.
sort: string (optional) Example: created-at
Sort on one or more fields using comma separated values.
filter: string (optional) Example: 1
Filter on one or more fields using comma separated values filter[field]=1,2.
page: string (optional) Example: 10
Use page[limit]=10 to reduce the number of instances returned. Use ?page[offset]=10 to skip this many instances.

Response 200

HideShow

Body

{
    "links": {
        "self": "/reviews",
        "next": "/reviews?page[offset]=10",
        "last": "/reviews?page[offset]=100"
    },
    "meta": {
        "total": 110
    },
    "data": [{
        "id": "c8sh5y9hdSMS6zVnrvf53T",
        "type": "reviews",
        "attributes": {
            "name": "Fall Specials",
            "status": "pending",
            "compliance-kind": "pre",
            "kind": "engagement",
            "content-count": 4,
            "is-archived": false,
            "created-at": "2020-01-01T00:00:00+00:00",
            "updated-at": "2020-01-01T00:00:00+00:00"
        },
        "relationships": {
            "comments": {
                "links": {
                    "related": "/reviews/c8sh5y9hdSMS6zVnrvf53T/comments"
                }
            },
            "engagement": {
                "data": {"type": "engagements", "id": "Vnrvf53Tc8shdSMS6zh5y9"}
            },
            "email-templates": {
                "data": [
                    {"type": "email-templates", "id": "ZskVKR7C7WgdvytxeTSP3d"},
                    {"type": "email-templates", "id": "Vnrvf53Tc8shdSMS6zh5y9"}
                ]
            }
            "voice-templates": {
                "data": [
                    {"type": "voice-templates", "id": "r58hTKT7AYS9dojRaF56o2"}
                ]
            }
            "text-templates": {
                "data": [
                    {"type": "text-templates", "id": "KR7C7WgdvytxeTSP3dZskV"}
                ]
            },
            "page": {
                "data": null
            },
            "post": {
                "data": null
            },
            "created-by": {
                "data": {"type": "memberships", "id": "C7xWERND6yBTpJJVHACzVf"}
            },
            "updated-by": {
                "data": {"type": "memberships", "id": "C7xWERND6yBTpJJVHACzVf"}
            }
        }
    }]
}

Review ¶

This resource manages updating and retrieving a specified review instance.

Note: Only one pending review can exist for a given related kind (e.g. an instance of engagement).

Retrieve Review
GET`/reviews/`

Retrieve an existing review instance.

Example URI

GET https://api.omnigage.io/api/v1/reviews/

Response 200

HideShow

Body

{
    "data": {
        "id": "c8sh5y9hdSMS6zVnrvf53T",
        "type": "reviews",
        "attributes": {
            "name": "Fall Specials",
            "status": "pending",
            "compliance-kind": "pre",
            "kind": "engagement",
            "content-count": 4,
            "is-archived": false,
            "created-at": "2020-01-01T00:00:00+00:00",
            "updated-at": "2020-01-01T00:00:00+00:00"
        },
        "relationships": {
            "comments": {
                "links": {
                    "related": "/reviews/c8sh5y9hdSMS6zVnrvf53T/comments"
                }
            },
            "engagement": {
                "data": {"type": "engagements", "id": "Vnrvf53Tc8shdSMS6zh5y9"}
            },
            "email-templates": {
                "data": [
                    {"type": "email-templates", "id": "ZskVKR7C7WgdvytxeTSP3d"},
                    {"type": "email-templates", "id": "Vnrvf53Tc8shdSMS6zh5y9"}
                ]
            }
            "voice-templates": {
                "data": [
                    {"type": "voice-templates", "id": "r58hTKT7AYS9dojRaF56o2"}
                ]
            }
            "text-templates": {
                "data": [
                    {"type": "text-templates", "id": "KR7C7WgdvytxeTSP3dZskV"}
                ]
            },
            "page": {
                "data": null
            },
            "post": {
                "data": null
            },
            "created-by": {
                "data": {"type": "memberships", "id": "C7xWERND6yBTpJJVHACzVf"}
            },
            "updated-by": {
                "data": {"type": "memberships", "id": "C7xWERND6yBTpJJVHACzVf"}
            }
        }
    }
}

Update Review
PATCH`/reviews/`

Update an existing review instance.

Note: The following status and permission handling:

Once is-archived is true, the review cannot be edited.
Only memberships assigned is-compliance-admin role can set status to approved, declined or reviewed.
Any membership with write access to the related kind can change the status to closed.

Example URI

PATCH https://api.omnigage.io/api/v1/reviews/

Request

HideShow

Body

{
    "data": {
        "id": "c8sh5y9hdSMS6zVnrvf53T",
        "type": "reviews",
        "attributes": {
            "name": "Fall Specials",
            "status": "pending",
            "compliance-kind": "pre",
            "kind": "engagement",
            "content-count": 4,
            "is-archived": false,
            "created-at": "2020-01-01T00:00:00+00:00",
            "updated-at": "2020-01-01T00:00:00+00:00"
        },
        "relationships": {
            "comments": {
                "links": {
                    "related": "/reviews/c8sh5y9hdSMS6zVnrvf53T/comments"
                }
            },
            "engagement": {
                "data": {"type": "engagements", "id": "Vnrvf53Tc8shdSMS6zh5y9"}
            },
            "email-templates": {
                "data": [
                    {"type": "email-templates", "id": "ZskVKR7C7WgdvytxeTSP3d"},
                    {"type": "email-templates", "id": "Vnrvf53Tc8shdSMS6zh5y9"}
                ]
            }
            "voice-templates": {
                "data": [
                    {"type": "voice-templates", "id": "r58hTKT7AYS9dojRaF56o2"}
                ]
            }
            "text-templates": {
                "data": [
                    {"type": "text-templates", "id": "KR7C7WgdvytxeTSP3dZskV"}
                ]
            },
            "page": {
                "data": null
            },
            "post": {
                "data": null
            },
            "created-by": {
                "data": {"type": "memberships", "id": "C7xWERND6yBTpJJVHACzVf"}
            },
            "updated-by": {
                "data": {"type": "memberships", "id": "C7xWERND6yBTpJJVHACzVf"}
            }
        }
    }
}

Response 202

HideShow

Body

{
    "data": {
        "id": "c8sh5y9hdSMS6zVnrvf53T",
        "type": "reviews",
        "attributes": {
            "name": "Fall Specials",
            "status": "pending",
            "compliance-kind": "pre",
            "kind": "engagement",
            "content-count": 4,
            "is-archived": false,
            "created-at": "2020-01-01T00:00:00+00:00",
            "updated-at": "2020-01-01T00:00:00+00:00"
        },
        "relationships": {
            "comments": {
                "links": {
                    "related": "/reviews/c8sh5y9hdSMS6zVnrvf53T/comments"
                }
            },
            "engagement": {
                "data": {"type": "engagements", "id": "Vnrvf53Tc8shdSMS6zh5y9"}
            },
            "email-templates": {
                "data": [
                    {"type": "email-templates", "id": "ZskVKR7C7WgdvytxeTSP3d"},
                    {"type": "email-templates", "id": "Vnrvf53Tc8shdSMS6zh5y9"}
                ]
            }
            "voice-templates": {
                "data": [
                    {"type": "voice-templates", "id": "r58hTKT7AYS9dojRaF56o2"}
                ]
            }
            "text-templates": {
                "data": [
                    {"type": "text-templates", "id": "KR7C7WgdvytxeTSP3dZskV"}
                ]
            },
            "page": {
                "data": null
            },
            "post": {
                "data": null
            },
            "created-by": {
                "data": {"type": "memberships", "id": "C7xWERND6yBTpJJVHACzVf"}
            },
            "updated-by": {
                "data": {"type": "memberships", "id": "C7xWERND6yBTpJJVHACzVf"}
            }
        }
    }
}

Review Comment Collection ¶

This resource manages the retrieval of a given review’s comments and creation.

Retrieve Review Comments
GET`/reviews/comments{?include,filter,sort,page}`

Retrieve a collection of review comments.

Example URI

GET https://api.omnigage.io/api/v1/reviews/comments?include=&filter=1&sort=created-at&page=10

URI Parameters

HideShow

include: string (optional)
Include one ore more related relationships using comma separated name.
sort: string (optional) Example: created-at
Sort on one or more fields using comma separated values.
filter: string (optional) Example: 1
Filter on one or more fields using comma separated values filter[field]=1,2.
page: string (optional) Example: 10
Use page[limit]=10 to reduce the number of instances returned. Use ?page[offset]=10 to skip this many instances.

Response 200

HideShow

Body

{
  "links": {
    "self": "/reviews/vytxeTZskVKR7C7WgdSP3d/comments",
    "next": "/reviews/vytxeTZskVKR7C7WgdSP3d/comments?page[offset]=10",
    "last": "/reviews/vytxeTZskVKR7C7WgdSP3d/comments?page[offset]=100"
  },
  "meta": {
    "total": 110
  },
  "data": [
    {
      "id": "RaF56o2r58hTKT7AYS9doj",
      "type": "reviews-comments",
      "attributes": {
        "body": "Kindly remove the mention of 'guarantee'.",
        "created-at": "2020-01-01T00:00:00+00:00",
        "updated-at": "2020-01-01T00:00:00+00:00"
      },
      "relationships": {
        "created-by": {
          "data": {
            "type": "memberships",
            "id": "C7xWERND6yBTpJJVHACzVf"
          }
        },
        "review": {
          "data": {
            "type": "reviews",
            "id": "vytxeTZskVKR7C7WgdSP3d"
          }
        }
      }
    }
  ]
}

Create Review Comment
POST`/reviews/comments`

Create a new review comment instance.

Note: Comments can be added to a review that is in a state of is-archived.

Example URI

POST https://api.omnigage.io/api/v1/reviews/comments

Request

HideShow

Body

{
  "data": {
    "id": "RaF56o2r58hTKT7AYS9doj",
    "type": "reviews-comments",
    "attributes": {
      "body": "Kindly remove the mention of 'guarantee'.",
      "created-at": "2020-01-01T00:00:00+00:00",
      "updated-at": "2020-01-01T00:00:00+00:00"
    },
    "relationships": {
      "created-by": {
        "data": {
          "type": "memberships",
          "id": "C7xWERND6yBTpJJVHACzVf"
        }
      },
      "review": {
        "data": {
          "type": "reviews",
          "id": "vytxeTZskVKR7C7WgdSP3d"
        }
      }
    }
  }
}

Response 201

HideShow

Body

{
  "data": {
    "id": "RaF56o2r58hTKT7AYS9doj",
    "type": "reviews-comments",
    "attributes": {
      "body": "A connoisseur of fine wines.",
      "created-at": "2020-01-01T00:00:00+00:00",
      "updated-at": "2020-01-01T00:00:00+00:00"
    },
    "relationships": {
      "created-by": {
        "data": {
          "type": "memberships",
          "id": "C7xWERND6yBTpJJVHACzVf"
        }
      },
      "review": {
        "data": {
          "type": "reviews",
          "id": "vytxeTZskVKR7C7WgdSP3d"
        }
      }
    }
  }
}

Review Comment ¶

This resource manages retrieving a specified review comment instance.

Retrieve Review Comment
GET`/reviews/comments/`

Retrieve an existing review comment instance.

Example URI

GET https://api.omnigage.io/api/v1/reviews/comments/

Response 200

HideShow

Body

{
  "data": {
    "id": "RaF56o2r58hTKT7AYS9doj",
    "type": "reviews-comments",
    "attributes": {
      "body": "A connoisseur of fine wines.",
      "created-at": "2020-01-01T00:00:00+00:00",
      "updated-at": "2020-01-01T00:00:00+00:00"
    },
    "relationships": {
      "created-by": {
        "data": {
          "type": "memberships",
          "id": "C7xWERND6yBTpJJVHACzVf"
        }
      },
      "review": {
        "data": {
          "type": "reviews",
          "id": "vytxeTZskVKR7C7WgdSP3d"
        }
      }
    }
  }
}

Usage Metrics Resources ¶

Result Metric Collection ¶

This resource manages the retrieval of collections for result usage.

Retrieve Result Metrics
GET`/result-metrics/{type}{?include,filter,sort,page}`

Retrieve a collection of result usage.

Example URI

GET https://api.omnigage.io/api/v1/result-metrics/created-by?include=&filter=1&sort=created-at&page=10

URI Parameters

HideShow

type

string (required) Example: created-by

Type of metrics to return

Choices: created-by

include

string (optional)

Include one ore more related relationships using comma separated name.

sort

string (optional) Example: created-at

Sort on one or more fields using comma separated values.

filter

string (optional) Example: 1

Filter on one or more fields using comma separated values filter[field]=1,2.

page

string (optional) Example: 10

Use page[limit]=10 to reduce the number of instances returned. Use ?page[offset]=10 to skip this many instances.

Response 200

HideShow

Body

{
  "links": {
    "self": "/result-metrics/created-by",
    "next": "/result-metrics/created-by?page[offset]=10",
    "last": "/result-metrics/created-by?page[offset]=100"
  },
  "meta": {
    "total": 1
  },
  "data": [
    {
      "id": "hdSMS6zVnrvf53Tc8sh5y9",
      "type": "result-metrics",
      "attributes": {
        "call-seconds": 19092,
        "direction": "outbound",
        "counts": {
          "call-queued": 46990,
          "call-ringing": 45111,
          "call-answered": 39330,
          "call-voicemail-drop": 4935,
          "call-human": 8144,
          "call-machine": 10241,
          "call-hangup": 2101,
          "call-unanswered": 3977,
          "call-busy": 1255,
          "call-failed": 0,
          "call-canceled": 45,
          "call-completed": 37399,
          "call-play-drop": 839,
          "call-play": 9019,
          "call-say": 2838,
          "call-gather": 142,
          "call-prompt": 590,
          "call-conference": 200,
          "call-enqueue": 104,
          "call-notify": 201,
          "call-dial": 913,
          "call-pause": 322,
          "call-record": 542,
          "call-transfer": 315,
          "call-activity": 1201,
          "email-queued": 16077,
          "email-sent": 0,
          "email-delivered": 0,
          "email-open": 13300,
          "email-click": 79800,
          "email-unsubscribe": 881,
          "email-bounce": 2554,
          "email-complaint": 26,
          "email-failed": 0,
          "text-queued": 37037,
          "text-sent": 36163,
          "text-delivered": 34163,
          "text-undelivered": 874,
          "text-failed": 0
        }
      },
      "relationships": {
        "created-by": {
          "data": {
            "type": "memberships",
            "id": "C7xWERND6yBTpJJVHACzVf"
          }
        }
      }
    }
  ]
}

Result Metric ¶

This resource manages retrieving result usage.

Retrieve Result Metric
GET`/result-metrics/{type}/{month}{?include,filter}`

Retrieve an individual result usage instance.

Example URI

GET https://api.omnigage.io/api/v1/result-metrics/created-by/2020-12?include=&filter=1

URI Parameters

HideShow

type

string (required) Example: created-by

Type of metrics to return

Choices: created-by account contact identity activity engagement

month

number (optional) Example: 2020-12

Limit by month. Format is ISO 8601 of YYYY-MM.

include

string (optional)

Include one ore more related relationships using comma separated name.

filter

string (optional) Example: 1

Filter on one or more fields using comma separated values filter[field]=1,2.

Response 200

HideShow

Body

{
  "data": {
    "id": "hdSMS6zVnrvf53Tc8sh5y9",
    "type": "result-metrics",
    "attributes": {
      "call-seconds": 19092,
      "direction": "outbound",
      "counts": {
        "call-queued": 46990,
        "call-ringing": 45111,
        "call-answered": 39330,
        "call-voicemail-drop": 4935,
        "call-human": 8144,
        "call-machine": 10241,
        "call-hangup": 2101,
        "call-unanswered": 3977,
        "call-busy": 1255,
        "call-failed": 0,
        "call-canceled": 45,
        "call-completed": 37399,
        "call-play-drop": 839,
        "call-play": 9019,
        "call-say": 2838,
        "call-gather": 142,
        "call-prompt": 590,
        "call-conference": 200,
        "call-enqueue": 104,
        "call-notify": 201,
        "call-dial": 913,
        "call-pause": 322,
        "call-record": 542,
        "call-transfer": 315,
        "call-activity": 1201,
        "email-queued": 16077,
        "email-sent": 0,
        "email-delivered": 0,
        "email-open": 13300,
        "email-click": 79800,
        "email-unsubscribe": 881,
        "email-bounce": 2554,
        "email-complaint": 26,
        "email-failed": 0,
        "text-queued": 37037,
        "text-sent": 36163,
        "text-delivered": 34163,
        "text-undelivered": 874,
        "text-failed": 0
      }
    },
    "relationships": {
      "created-by": {
        "data": {
          "type": "memberships",
          "id": "C7xWERND6yBTpJJVHACzVf"
        }
      }
    }
  }
}

Call Time Metric ¶

This resource manages retrieving call time metrics.

Retrieve Call Time Metric
GET`/call-time-metrics/{type}/{?include,filter}`

Retrieve an individual call time metrics.

Example URI

GET https://api.omnigage.io/api/v1/call-time-metrics/contact/?include=&filter=1

URI Parameters

HideShow

type

string (required) Example: contact

Type of metrics to return

Choices: contact identity

include

string (optional)

Include one ore more related relationships using comma separated name.

filter

string (optional) Example: 1

Use filter[created-by.id] to restrict collection to only include items that have the created by membership id. Filter on one or more fields using comma separated values filter[field]=1,2.

Response 200

HideShow

Body

{
  "data": {
    "id": "hdSMS6zVnrvf53Tc8sh5y9",
    "type": "call-time-metrics",
    "attributes": {
      "answered": {
        "00:00": 0,
        "01:00": 0,
        "02:00": 0,
        "03:00": 0,
        "04:00": 0,
        "05:00": 0,
        "06:00": 0,
        "07:00": 0,
        "08:00": 0,
        "09:00": 0,
        "10:00": 0,
        "11:00": 0,
        "12:00": 2,
        "13:00": 1,
        "14:00": 4,
        "15:00": 0,
        "16:00": 0,
        "17:00": 0,
        "18:00": 0,
        "19:00": 0,
        "20:00": 0,
        "21:00": 0,
        "22:00": 0,
        "23:00": 0
      },
      "unanswered": {
        "00:00": 0,
        "01:00": 0,
        "02:00": 0,
        "03:00": 0,
        "04:00": 0,
        "05:00": 0,
        "06:00": 0,
        "07:00": 3,
        "08:00": 9,
        "09:00": 1,
        "10:00": 2,
        "11:00": 0,
        "12:00": 0,
        "13:00": 0,
        "14:00": 0,
        "15:00": 0,
        "16:00": 0,
        "17:00": 0,
        "18:00": 3,
        "19:00": 7,
        "20:00": 0,
        "21:00": 0,
        "22:00": 0,
        "23:00": 0
      }
    },
    "relationships": {
      "contact": {
        "data": {
          "type": "contacts",
          "id": "hdSMS6zVnrvf53Tc8sh5y9"
        }
      }
    }
  }
}

Storage Metric Collection ¶

This resource manages the retrieval of collections for storage usage.

Retrieve Storage Metrics
GET`/storage-metrics/{type}{?include,filter,sort,page,type}`

Retrieve a collection of storage usage.

Example URI

GET https://api.omnigage.io/api/v1/storage-metrics/memberships?include=&filter=1&sort=created-at&page=10&type=memberships

URI Parameters

HideShow

type

string (required) Example: memberships

Type of metrics to return

Choices: memberships accounts

include

string (optional)

Include one ore more related relationships using comma separated name.

sort

string (optional) Example: created-at

Sort on one or more fields using comma separated values.

filter

string (optional) Example: 1

Filter on one or more fields using comma separated values filter[field]=1,2.

page

string (optional) Example: 10

Use page[limit]=10 to reduce the number of instances returned. Use ?page[offset]=10 to skip this many instances.

Response 200

HideShow

Body

{
  "links": {
    "self": "/storage-metrics/memberships",
    "next": "/storage-metrics/memberships?page[offset]=10",
    "last": "/storage-metrics/memberships?page[offset]=100"
  },
  "meta": {
    "total": 1
  },
  "data": [
    {
      "id": "hdSMS6zVnrvf53Tc8sh5y9",
      "type": "storage-metrics",
      "attributes": {
        "audio-bytes": 432041,
        "text-bytes": 812354,
        "image-bytes": 599215,
        "total-bytes": 1843610
      },
      "relationships": {
        "membership": {
          "data": {
            "type": "memberships",
            "id": "hdSMS6zVnrvf53Tc8sh5y9"
          }
        }
      }
    }
  ]
}

Storage Metric ¶

This resource manages retrieving storage usage.

Retrieve Storage Metric
GET`/storage-metrics/{type}/{month}`

Retrieve an individual storage usage instance.

Example URI

GET https://api.omnigage.io/api/v1/storage-metrics/memberships/2020-12

URI Parameters

HideShow

type

string (required) Example: memberships

Type of metrics to return

Choices: memberships accounts

month

number (optional) Example: 2020-12

Limit by month. Format is ISO 8601 of YYYY-MM.

Response 200

HideShow

Body

{
  "data": {
    "id": "hdSMS6zVnrvf53Tc8sh5y9",
    "type": "storage-metrics",
    "attributes": {
      "audio-bytes": 432041,
      "text-bytes": 812354,
      "image-bytes": 599215,
      "total-bytes": 1843610
    },
    "relationships": {
      "membership": {
        "data": {
          "type": "memberships",
          "id": "hdSMS6zVnrvf53Tc8sh5y9"
        }
      }
    }
  }
}

Voice Template Metric ¶

This resource manages retrieving an aggregation of metric counts for the type and id pair.

Retrieve Voice Template Metric
GET`/voice-template-metrics/{type}/{?include}`

Retrieve an individual result usage instance.

Example URI

GET https://api.omnigage.io/api/v1/voice-template-metrics/type/?include=

URI Parameters

HideShow

type

string (required)

Type of metrics to return

Choices: activity envelope voice-template

include

string (optional)

Include one ore more related relationships using comma separated name.

Response 200

HideShow

Body

{
  "data": {
    "id": "hdSMS6zVnrvf53Tc8sh5y9",
    "type": "voice-template-metrics",
    "attributes": {
      "percents": {
        "1": 8,
        "2": 7,
        "3": 7,
        "4": 9,
        "5": 9,
        "6": 9,
        "7": 9,
        "8": 9,
        "9": 9,
        "10": 9,
        "11": 8,
        "12": 8,
        "13": 9,
        "14": 7,
        "15": 8,
        "16": 8,
        "17": 9,
        "18": 9,
        "19": 9,
        "20": 10,
        "21": 10,
        "22": 10,
        "23": 9,
        "24": 8,
        "25": 8,
        "26": 8,
        "27": 7,
        "28": 6,
        "29": 6,
        "30": 5,
        "31": 5,
        "32": 5,
        "33": 5,
        "34": 5,
        "35": 5,
        "36": 5,
        "37": 5,
        "38": 4,
        "39": 4,
        "40": 4,
        "41": 4,
        "42": 4,
        "43": 4,
        "44": 4,
        "45": 4,
        "46": 4,
        "47": 4,
        "48": 4,
        "49": 4,
        "50": 4,
        "51": 4,
        "52": 4,
        "53": 4,
        "54": 5,
        "55": 5,
        "56": 5,
        "57": 5,
        "58": 5,
        "59": 6,
        "60": 6,
        "61": 6,
        "62": 6,
        "63": 6,
        "64": 6,
        "65": 6,
        "66": 7,
        "67": 7,
        "68": 7,
        "69": 7,
        "70": 8,
        "71": 7,
        "72": 7,
        "73": 7,
        "74": 8,
        "75": 7,
        "76": 7,
        "77": 7,
        "78": 7,
        "79": 7,
        "80": 7,
        "81": 7,
        "82": 7,
        "83": 7,
        "84": 7,
        "85": 7,
        "86": 7,
        "87": 8,
        "88": 8,
        "89": 8,
        "90": 8,
        "91": 8,
        "92": 8,
        "93": 8,
        "94": 9,
        "95": 8,
        "96": 8,
        "97": 8,
        "98": 9,
        "99": 9,
        "100": 9
      },
      "created-at": "2024-01-01T00:00:00+00:00",
      "updated-at": "2024-01-01T00:00:00+00:00"
    },
    "relationships": {
      "activity": {
        "data": {
          "type": "activities",
          "id": "C7xWERND6yBTpJJVHACzVf"
        }
      }
    }
  }
}

Identity Resources ¶

Caller ID Collection ¶

This resource provides querying of the caller ids collection along with the creation of caller id instances.

Retrieve Caller ID
GET`/caller-ids{?include,filter,sort,page}`

Retrieve a collection of caller ids.

Example URI

GET https://api.omnigage.io/api/v1/caller-ids?include=&filter=1&sort=created-at&page=10

URI Parameters

HideShow

include: string (optional)
Include one ore more related relationships using comma separated name.
sort: string (optional) Example: created-at
Sort on one or more fields using comma separated values.
filter: string (optional) Example: 1
Filter on one or more fields using comma separated values filter[field]=1,2.
page: string (optional) Example: 10
Use page[limit]=10 to reduce the number of instances returned. Use ?page[offset]=10 to skip this many instances.

Response 200

HideShow

Body

{
  "links": {
    "self": "/caller-ids",
    "next": "/caller-ids?page[offset]=10",
    "last": "/caller-ids?page[offset]=100"
  },
  "meta": {
    "total": 10
  },
  "data": [
    {
      "id": "C8pd8zmNeCCydUAaXXaQZ4",
      "type": "caller-ids",
      "attributes": {
        "label": "Headquarters",
        "phone-number": "+15197566220",
        "status": "pending",
        "verification-code": 729140,
        "is-archived": false,
        "created-at": "2020-01-01T00:00:00+00:00",
        "updated-at": "2020-01-01T00:00:00+00:00",
        "deleted-at": null
      },
      "relationships": {
        "parent": {
          "data": {
            "type": "phone-numbers",
            "id": "yxLyyftrAUNWu4qhvefnrf"
          }
        },
        "created-by": {
          "data": {
            "type": "memberships",
            "id": "C7xWERND6yBTpJJVHACzVf"
          }
        },
        "updated-by": {
          "data": {
            "type": "memberships",
            "id": "C7xWERND6yBTpJJVHACzVf"
          }
        },
        "deleted-by": {
          "data": null
        }
      }
    }
  ]
}

Create Caller ID
POST`/caller-ids`

Create a new caller ids instance.

Example URI

POST https://api.omnigage.io/api/v1/caller-ids

Request

HideShow

Body

{
  "data": {
    "type": "caller-ids",
    "attributes": {
      "label": "Headquarters",
      "phone-number": "+15197566220"
    }
  }
}

Response 201

HideShow

Body

{
  "data": {
    "id": "C8pd8zmNeCCydUAaXXaQZ4",
    "type": "caller-ids",
    "attributes": {
      "label": "Headquarters",
      "phone-number": "+15197566220",
      "status": "pending",
      "verification-code": 729140,
      "is-archived": false,
      "created-at": "2020-01-01T00:00:00+00:00",
      "updated-at": "2020-01-01T00:00:00+00:00",
      "deleted-at": null
    },
    "relationships": {
      "parent": {
        "data": {
          "type": "phone-numbers",
          "id": "yxLyyftrAUNWu4qhvefnrf"
        }
      },
      "created-by": {
        "data": {
          "type": "memberships",
          "id": "C7xWERND6yBTpJJVHACzVf"
        }
      },
      "updated-by": {
        "data": {
          "type": "memberships",
          "id": "C7xWERND6yBTpJJVHACzVf"
        }
      },
      "deleted-by": {
        "data": null
      }
    }
  }
}

Caller ID ¶

This resource manages updating, archiving, and retrieving a specified caller id instance.

Retrieve Caller ID
GET`/caller-ids/`

Retrieve an existing caller ids instance.

Example URI

GET https://api.omnigage.io/api/v1/caller-ids/

Response 200

HideShow

Body

{
  "data": {
    "id": "C8pd8zmNeCCydUAaXXaQZ4",
    "type": "caller-ids",
    "attributes": {
      "label": "Headquarters",
      "phone-number": "+15197566220",
      "status": "pending",
      "verification-code": 729140,
      "is-archived": false,
      "created-at": "2020-01-01T00:00:00+00:00",
      "updated-at": "2020-01-01T00:00:00+00:00",
      "deleted-at": null
    },
    "relationships": {
      "parent": {
        "data": {
          "type": "phone-numbers",
          "id": "yxLyyftrAUNWu4qhvefnrf"
        }
      },
      "created-by": {
        "data": {
          "type": "memberships",
          "id": "C7xWERND6yBTpJJVHACzVf"
        }
      },
      "updated-by": {
        "data": {
          "type": "memberships",
          "id": "C7xWERND6yBTpJJVHACzVf"
        }
      },
      "deleted-by": {
        "data": null
      }
    }
  }
}

Update Caller ID
PATCH`/caller-ids/`

Update an existing caller ids instance.

Note: If the instance carries a parent relationship, an error will be returned. To update, see the phone-number.

Example URI

PATCH https://api.omnigage.io/api/v1/caller-ids/

Request

HideShow

Body

{
  "data": {
    "id": "C8pd8zmNeCCydUAaXXaQZ4",
    "type": "caller-ids",
    "attributes": {
      "label": "Headquarters"
    }
  }
}

Response 202

HideShow

Body

{
  "data": {
    "id": "C8pd8zmNeCCydUAaXXaQZ4",
    "type": "caller-ids",
    "attributes": {
      "label": "Headquarters",
      "phone-number": "+15197566220",
      "status": "pending",
      "verification-code": 729140,
      "is-archived": false,
      "created-at": "2020-01-01T00:00:00+00:00",
      "updated-at": "2020-01-01T00:00:00+00:00",
      "deleted-at": null
    },
    "relationships": {
      "parent": {
        "data": {
          "type": "phone-numbers",
          "id": "yxLyyftrAUNWu4qhvefnrf"
        }
      },
      "created-by": {
        "data": {
          "type": "memberships",
          "id": "C7xWERND6yBTpJJVHACzVf"
        }
      },
      "updated-by": {
        "data": {
          "type": "memberships",
          "id": "C7xWERND6yBTpJJVHACzVf"
        }
      },
      "deleted-by": {
        "data": null
      }
    }
  }
}

Delete Caller ID
DELETE`/caller-ids/`

Delete an existing caller ids instance. Note: The actual instance is not deleted and is-archived will be set to true. The following will occur:

Status will be changed to pending and the verification process will need to occur again.
A new caller-id can be created and verified. Only one verified unique caller-id can exist at a time.

Note: If the instance carries a parent relationship, it cannot be deleted. To delete, see the phone-number.

Example URI

DELETE https://api.omnigage.io/api/v1/caller-ids/

Response 204

Caller ID Collaborator Collection ¶

This resource manages the retrieval of collaborator collections and the creation of collaborator instances.

Retrieve Caller ID Collaborators
GET`/caller-ids/collaborators{?include,sort,filter,page}`

Retrieve a collection of collaborators.

Example URI

GET https://api.omnigage.io/api/v1/caller-ids/collaborators?include=&sort=created-at&filter=1&page=10

URI Parameters

HideShow

include: string (optional)
Include one ore more related relationships using comma separated name.
sort: string (optional) Example: created-at
Sort on one or more fields using comma separated values.
filter: string (optional) Example: 1
Filter on one or more fields using comma separated values filter[field]=1,2.
page: string (optional) Example: 10
Use page[limit]=10 to reduce the number of instances returned. Use ?page[offset]=10 to skip this many instances.

Response 200

HideShow

Body

{
  "links": {
    "self": "/caller-ids/97iQjGNFLTZ5oxfYTKinwo/collaborators",
    "next": "/caller-ids/97iQjGNFLTZ5oxfYTKinwo/collaborators?page[offset]=10",
    "last": "/caller-ids/97iQjGNFLTZ5oxfYTKinwo/collaborators?page[offset]=100"
  },
  "meta": {
    "total": 1
  },
  "data": [
    {
      "id": "RaF56o2r58hTKT7AYS9doj",
      "type": "caller-ids-collaborators",
      "attributes": {
        "permission": "write",
        "is-archived": false,
        "created-at": "2020-01-01T00:00:00+00:00",
        "updated-at": "2020-01-01T00:00:00+00:00",
        "deleted-at": null
      },
      "relationships": {
        "membership": {
          "data": {
            "type": "memberships",
            "id": "6jVhCt5kE2p6e7B7SX9CGe"
          }
        },
        "team": {
          "data": null
        },
        "caller-id": {
          "data": {
            "type": "caller-ids",
            "id": "97iQjGNFLTZ5oxfYTKinwo"
          }
        },
        "created-by": {
          "data": {
            "type": "memberships",
            "id": "C7xWERND6yBTpJJVHACzVf"
          }
        },
        "updated-by": {
          "data": {
            "type": "memberships",
            "id": "C7xWERND6yBTpJJVHACzVf"
          }
        },
        "deleted-by": {
          "data": null
        }
      }
    }
  ]
}

Create Caller ID Collaborator
POST`/caller-ids/collaborators`

Create a new collaborator instance.

Example URI

POST https://api.omnigage.io/api/v1/caller-ids/collaborators

Request

HideShow

Body

{
  "data": {
    "type": "caller-ids-collaborators",
    "attributes": {
      "permission": "write"
    },
    "relationships": {
      "membership": {
        "data": {
          "type": "memberships",
          "id": "6jVhCt5kE2p6e7B7SX9CGe"
        }
      },
      "caller-id": {
        "data": {
          "type": "caller-ids",
          "id": "97iQjGNFLTZ5oxfYTKinwo"
        }
      }
    }
  }
}

Response 201

HideShow

Body

{
  "data": {
    "id": "RaF56o2r58hTKT7AYS9doj",
    "type": "caller-ids-collaborators",
    "attributes": {
      "permission": "write",
      "is-archived": false,
      "created-at": "2020-01-01T00:00:00+00:00",
      "updated-at": "2020-01-01T00:00:00+00:00",
      "deleted-at": null
    },
    "relationships": {
      "membership": {
        "data": {
          "type": "memberships",
          "id": "6jVhCt5kE2p6e7B7SX9CGe"
        }
      },
      "team": {
        "data": null
      },
      "caller-id": {
        "data": {
          "type": "caller-ids",
          "id": "97iQjGNFLTZ5oxfYTKinwo"
        }
      },
      "created-by": {
        "data": {
          "type": "memberships",
          "id": "C7xWERND6yBTpJJVHACzVf"
        }
      },
      "updated-by": {
        "data": {
          "type": "memberships",
          "id": "C7xWERND6yBTpJJVHACzVf"
        }
      },
      "deleted-by": {
        "data": null
      }
    }
  }
}

Caller ID Collaborator ¶

This resource manages updating and retrieving a specified collaborator instance.

Retrieve Caller ID Collaborator
GET`/caller-ids/collaborators/`

Retrieve an existing collaborator instance.

Example URI

GET https://api.omnigage.io/api/v1/caller-ids/collaborators/

Response 200

HideShow

Body

{
  "data": {
    "id": "RaF56o2r58hTKT7AYS9doj",
    "type": "caller-ids-collaborators",
    "attributes": {
      "permission": "write",
      "is-archived": false,
      "created-at": "2020-01-01T00:00:00+00:00",
      "updated-at": "2020-01-01T00:00:00+00:00",
      "deleted-at": null
    },
    "relationships": {
      "membership": {
        "data": {
          "type": "memberships",
          "id": "6jVhCt5kE2p6e7B7SX9CGe"
        }
      },
      "team": {
        "data": null
      },
      "caller-id": {
        "data": {
          "type": "caller-ids",
          "id": "97iQjGNFLTZ5oxfYTKinwo"
        }
      },
      "created-by": {
        "data": {
          "type": "memberships",
          "id": "C7xWERND6yBTpJJVHACzVf"
        }
      },
      "updated-by": {
        "data": {
          "type": "memberships",
          "id": "C7xWERND6yBTpJJVHACzVf"
        }
      },
      "deleted-by": {
        "data": null
      }
    }
  }
}

Update Caller ID Collaborator
PATCH`/caller-ids/collaborators/`

Update an existing collaborator instance.

Note: A membership cannot edit their own instance.

Example URI

PATCH https://api.omnigage.io/api/v1/caller-ids/collaborators/

Request

HideShow

Body

{
  "data": {
    "id": "RaF56o2r58hTKT7AYS9doj",
    "type": "caller-ids-collaborators",
    "attributes": {
      "permission": "write",
      "is-archived": false,
      "created-at": "2020-01-01T00:00:00+00:00",
      "updated-at": "2020-01-01T00:00:00+00:00",
      "deleted-at": null
    },
    "relationships": {
      "membership": {
        "data": {
          "type": "memberships",
          "id": "6jVhCt5kE2p6e7B7SX9CGe"
        }
      },
      "team": {
        "data": null
      },
      "caller-id": {
        "data": {
          "type": "caller-ids",
          "id": "97iQjGNFLTZ5oxfYTKinwo"
        }
      },
      "created-by": {
        "data": {
          "type": "memberships",
          "id": "C7xWERND6yBTpJJVHACzVf"
        }
      },
      "updated-by": {
        "data": {
          "type": "memberships",
          "id": "C7xWERND6yBTpJJVHACzVf"
        }
      },
      "deleted-by": {
        "data": null
      }
    }
  }
}

Response 202

HideShow

Body

{
  "data": {
    "id": "RaF56o2r58hTKT7AYS9doj",
    "type": "caller-ids-collaborators",
    "attributes": {
      "permission": "write",
      "is-archived": false,
      "created-at": "2020-01-01T00:00:00+00:00",
      "updated-at": "2020-01-01T00:00:00+00:00",
      "deleted-at": null
    },
    "relationships": {
      "membership": {
        "data": {
          "type": "memberships",
          "id": "6jVhCt5kE2p6e7B7SX9CGe"
        }
      },
      "team": {
        "data": null
      },
      "caller-id": {
        "data": {
          "type": "caller-ids",
          "id": "97iQjGNFLTZ5oxfYTKinwo"
        }
      },
      "created-by": {
        "data": {
          "type": "memberships",
          "id": "C7xWERND6yBTpJJVHACzVf"
        }
      },
      "updated-by": {
        "data": {
          "type": "memberships",
          "id": "C7xWERND6yBTpJJVHACzVf"
        }
      },
      "deleted-by": {
        "data": null
      }
    }
  }
}

Delete Caller ID Collaborator
DELETE`/caller-ids/collaborators/`

Sets the is-archived field’s value to true. Note: The actual instance is not deleted.

Note: A membership cannot delete their own instance.

Example URI

DELETE https://api.omnigage.io/api/v1/caller-ids/collaborators/

Response 204

Email ID Collection ¶

This resource provides querying of the email ids collection along with the creation of email id instances.

Retrieve Email ID
GET`/email-ids{?include,filter,sort,page}`

Retrieve a collection of email ids.

Example URI

GET https://api.omnigage.io/api/v1/email-ids?include=&filter=1&sort=created-at&page=10

URI Parameters

HideShow

include: string (optional)
Include one ore more related relationships using comma separated name.
sort: string (optional) Example: created-at
Sort on one or more fields using comma separated values.
filter: string (optional) Example: 1
Filter on one or more fields using comma separated values filter[field]=1,2.
page: string (optional) Example: 10
Use page[limit]=10 to reduce the number of instances returned. Use ?page[offset]=10 to skip this many instances.

Response 200

HideShow

Body

{
  "links": {
    "self": "/email-ids",
    "next": "/email-ids?page[offset]=10",
    "last": "/email-ids?page[offset]=100"
  },
  "meta": {
    "total": 10
  },
  "data": [
    {
      "id": "cXEm7dHihzTjMbuPgzqNiP",
      "type": "email-ids",
      "attributes": {
        "label": "Alexander Bell",
        "email-address": "alexander.bell@bell-labs.com",
        "status": "verified",
        "is-archived": false,
        "created-at": "2020-01-01T00:00:00+00:00",
        "updated-at": "2020-01-01T00:00:00+00:00",
        "deleted-at": null
      },
      "relationships": {
        "created-by": {
          "data": {
            "type": "memberships",
            "id": "C7xWERND6yBTpJJVHACzVf"
          }
        },
        "updated-by": {
          "data": {
            "type": "memberships",
            "id": "C7xWERND6yBTpJJVHACzVf"
          }
        },
        "deleted-by": {
          "data": null
        }
      }
    }
  ]
}

Create Email ID
POST`/email-ids`

Create a new email-ids and verify the email-address in order to use the identity for sending emails.

For accounts that have many users with the same email domain, email ID verification can be expedited by verifying an email-domain. If the authenticated user already has a confirmed users-emails with a matching confirmed email-domain within the account, the email-ids instance will be immediately verified. If not, an email will be sent to the email-address requiring user action.

Example URI

POST https://api.omnigage.io/api/v1/email-ids

Request

HideShow

Body

{
  "data": {
    "type": "email-ids",
    "attributes": {
      "label": "Alexander Bell",
      "email-address": "alexander.bell@bell-labs.com"
    }
  }
}

Response 201

HideShow

Body

{
  "data": {
    "id": "cXEm7dHihzTjMbuPgzqNiP",
    "type": "email-ids",
    "attributes": {
      "label": "Alexander Bell",
      "email-address": "alexander.bell@bell-labs.com",
      "status": "pending",
      "is-archived": false,
      "created-at": "2020-01-01T00:00:00+00:00",
      "updated-at": "2020-01-01T00:00:00+00:00",
      "deleted-at": null
    },
    "relationships": {
      "created-by": {
        "data": {
          "type": "memberships",
          "id": "C7xWERND6yBTpJJVHACzVf"
        }
      },
      "updated-by": {
        "data": {
          "type": "memberships",
          "id": "C7xWERND6yBTpJJVHACzVf"
        }
      },
      "deleted-by": {
        "data": null
      }
    }
  }
}

Email ID ¶

This resource manages updating, removing, and retrieving a specified email id instance.

Retrieve Email ID
GET`/email-ids/`

Retrieve an existing email ids instance.

Example URI

GET https://api.omnigage.io/api/v1/email-ids/

Response 200

HideShow

Body

{
  "data": {
    "id": "cXEm7dHihzTjMbuPgzqNiP",
    "type": "email-ids",
    "attributes": {
      "label": "Alexander Bell",
      "email-address": "alexander.bell@bell-labs.com",
      "status": "verified",
      "is-archived": false,
      "created-at": "2020-01-01T00:00:00+00:00",
      "updated-at": "2020-01-01T00:00:00+00:00",
      "deleted-at": null
    },
    "relationships": {
      "created-by": {
        "data": {
          "type": "memberships",
          "id": "C7xWERND6yBTpJJVHACzVf"
        }
      },
      "updated-by": {
        "data": {
          "type": "memberships",
          "id": "C7xWERND6yBTpJJVHACzVf"
        }
      },
      "deleted-by": {
        "data": null
      }
    }
  }
}

Update Email ID
PATCH`/email-ids/`

Update an existing email ids instance.

Example URI

PATCH https://api.omnigage.io/api/v1/email-ids/

Request

HideShow

Body

{
  "data": {
    "id": "cXEm7dHihzTjMbuPgzqNiP",
    "type": "email-ids",
    "attributes": {
      "is-archived": false
    }
  }
}

Response 202

HideShow

Body

{
  "data": {
    "id": "cXEm7dHihzTjMbuPgzqNiP",
    "type": "email-ids",
    "attributes": {
      "label": "Alexander Bell",
      "email-address": "alexander.bell@bell-labs.com",
      "status": "verified",
      "is-archived": false,
      "created-at": "2020-01-01T00:00:00+00:00",
      "updated-at": "2020-01-01T00:00:00+00:00",
      "deleted-at": null
    },
    "relationships": {
      "created-by": {
        "data": {
          "type": "memberships",
          "id": "C7xWERND6yBTpJJVHACzVf"
        }
      },
      "updated-by": {
        "data": {
          "type": "memberships",
          "id": "C7xWERND6yBTpJJVHACzVf"
        }
      },
      "deleted-by": {
        "data": null
      }
    }
  }
}

Request Send Confirmation

HideShow

Body

{
  "data": {
    "id": "cXEm7dHihzTjMbuPgzqNiP",
    "type": "email-ids",
    "attributes": {
      "is-to-send-confirmation": true
    }
  }
}

Response 202

HideShow

Body

{
  "data": {
    "id": "cXEm7dHihzTjMbuPgzqNiP",
    "type": "email-ids",
    "attributes": {
      "label": "Alexander Bell",
      "email-address": "alexander.bell@bell-labs.com",
      "status": "verified",
      "is-archived": false,
      "created-at": "2020-01-01T00:00:00+00:00",
      "updated-at": "2020-01-01T00:00:00+00:00",
      "deleted-at": null
    },
    "relationships": {
      "created-by": {
        "data": {
          "type": "memberships",
          "id": "C7xWERND6yBTpJJVHACzVf"
        }
      },
      "updated-by": {
        "data": {
          "type": "memberships",
          "id": "C7xWERND6yBTpJJVHACzVf"
        }
      },
      "deleted-by": {
        "data": null
      }
    }
  }
}

Delete Email ID
DELETE`/email-ids/`

Delete an existing email ids instance. Note: The instance will be archived and the status changed to revoked.

Example URI

DELETE https://api.omnigage.io/api/v1/email-ids/

Response 204

Email ID Collaborator Collection ¶

This resource manages the retrieval of collaborator collections and the creation of collaborator instances.

Retrieve Email ID Collaborators
GET`/email-ids/collaborators{?include,sort,filter,page}`

Retrieve a collection of collaborators.

Example URI

GET https://api.omnigage.io/api/v1/email-ids/collaborators?include=&sort=created-at&filter=1&page=10

URI Parameters

HideShow

include: string (optional)
Include one ore more related relationships using comma separated name.
sort: string (optional) Example: created-at
Sort on one or more fields using comma separated values.
filter: string (optional) Example: 1
Filter on one or more fields using comma separated values filter[field]=1,2.
page: string (optional) Example: 10
Use page[limit]=10 to reduce the number of instances returned. Use ?page[offset]=10 to skip this many instances.

Response 200

HideShow

Body

{
  "links": {
    "self": "/email-ids/97iQjGNFLTZ5oxfYTKinwo/collaborators",
    "next": "/email-ids/97iQjGNFLTZ5oxfYTKinwo/collaborators?page[offset]=10",
    "last": "/email-ids/97iQjGNFLTZ5oxfYTKinwo/collaborators?page[offset]=100"
  },
  "meta": {
    "total": 1
  },
  "data": [
    {
      "id": "RaF56o2r58hTKT7AYS9doj",
      "type": "email-ids-collaborators",
      "attributes": {
        "permission": "write",
        "is-archived": false,
        "created-at": "2020-01-01T00:00:00+00:00",
        "updated-at": "2020-01-01T00:00:00+00:00",
        "deleted-at": null
      },
      "relationships": {
        "membership": {
          "data": {
            "type": "memberships",
            "id": "6jVhCt5kE2p6e7B7SX9CGe"
          }
        },
        "team": {
          "data": null
        },
        "email-id": {
          "data": {
            "type": "email-ids",
            "id": "97iQjGNFLTZ5oxfYTKinwo"
          }
        },
        "created-by": {
          "data": {
            "type": "memberships",
            "id": "C7xWERND6yBTpJJVHACzVf"
          }
        },
        "updated-by": {
          "data": {
            "type": "memberships",
            "id": "C7xWERND6yBTpJJVHACzVf"
          }
        },
        "deleted-by": {
          "data": null
        }
      }
    }
  ]
}

Create Email ID Collaborator
POST`/email-ids/collaborators`

Create a new collaborator instance.

Example URI

POST https://api.omnigage.io/api/v1/email-ids/collaborators

Request

HideShow

Body

{
  "data": {
    "type": "email-ids-collaborators",
    "attributes": {
      "permission": "write"
    },
    "relationships": {
      "membership": {
        "data": {
          "type": "memberships",
          "id": "6jVhCt5kE2p6e7B7SX9CGe"
        }
      },
      "email-id": {
        "data": {
          "type": "email-ids",
          "id": "97iQjGNFLTZ5oxfYTKinwo"
        }
      }
    }
  }
}

Response 201

HideShow

Body

{
  "data": {
    "id": "RaF56o2r58hTKT7AYS9doj",
    "type": "email-ids-collaborators",
    "attributes": {
      "permission": "write",
      "is-archived": false,
      "created-at": "2020-01-01T00:00:00+00:00",
      "updated-at": "2020-01-01T00:00:00+00:00",
      "deleted-at": null
    },
    "relationships": {
      "membership": {
        "data": {
          "type": "memberships",
          "id": "6jVhCt5kE2p6e7B7SX9CGe"
        }
      },
      "team": {
        "data": null
      },
      "email-id": {
        "data": {
          "type": "email-ids",
          "id": "97iQjGNFLTZ5oxfYTKinwo"
        }
      },
      "created-by": {
        "data": {
          "type": "memberships",
          "id": "C7xWERND6yBTpJJVHACzVf"
        }
      },
      "updated-by": {
        "data": {
          "type": "memberships",
          "id": "C7xWERND6yBTpJJVHACzVf"
        }
      },
      "deleted-by": {
        "data": null
      }
    }
  }
}

Email ID Collaborator ¶

This resource manages updating and retrieving a specified collaborator instance.

Retrieve Email ID Collaborator
GET`/email-ids/collaborators/`

Retrieve an existing collaborator instance.

Example URI

GET https://api.omnigage.io/api/v1/email-ids/collaborators/

Response 200

HideShow

Body

{
  "data": {
    "id": "RaF56o2r58hTKT7AYS9doj",
    "type": "email-ids-collaborators",
    "attributes": {
      "permission": "write",
      "is-archived": false,
      "created-at": "2020-01-01T00:00:00+00:00",
      "updated-at": "2020-01-01T00:00:00+00:00",
      "deleted-at": null
    },
    "relationships": {
      "membership": {
        "data": {
          "type": "memberships",
          "id": "6jVhCt5kE2p6e7B7SX9CGe"
        }
      },
      "team": {
        "data": null
      },
      "email-id": {
        "data": {
          "type": "email-ids",
          "id": "97iQjGNFLTZ5oxfYTKinwo"
        }
      },
      "created-by": {
        "data": {
          "type": "memberships",
          "id": "C7xWERND6yBTpJJVHACzVf"
        }
      },
      "updated-by": {
        "data": {
          "type": "memberships",
          "id": "C7xWERND6yBTpJJVHACzVf"
        }
      },
      "deleted-by": {
        "data": null
      }
    }
  }
}

Update Email ID Collaborator
PATCH`/email-ids/collaborators/`

Update an existing collaborator instance.

Note: A membership cannot edit their own instance.

Example URI

PATCH https://api.omnigage.io/api/v1/email-ids/collaborators/

Request

HideShow

Body

{
  "data": {
    "id": "RaF56o2r58hTKT7AYS9doj",
    "type": "email-ids-collaborators",
    "attributes": {
      "permission": "write",
      "is-archived": false,
      "created-at": "2020-01-01T00:00:00+00:00",
      "updated-at": "2020-01-01T00:00:00+00:00",
      "deleted-at": null
    },
    "relationships": {
      "membership": {
        "data": {
          "type": "memberships",
          "id": "6jVhCt5kE2p6e7B7SX9CGe"
        }
      },
      "team": {
        "data": null
      },
      "email-id": {
        "data": {
          "type": "email-ids",
          "id": "97iQjGNFLTZ5oxfYTKinwo"
        }
      },
      "created-by": {
        "data": {
          "type": "memberships",
          "id": "C7xWERND6yBTpJJVHACzVf"
        }
      },
      "updated-by": {
        "data": {
          "type": "memberships",
          "id": "C7xWERND6yBTpJJVHACzVf"
        }
      },
      "deleted-by": {
        "data": null
      }
    }
  }
}

Response 202

HideShow

Body

{
  "data": {
    "id": "RaF56o2r58hTKT7AYS9doj",
    "type": "email-ids-collaborators",
    "attributes": {
      "permission": "write",
      "is-archived": false,
      "created-at": "2020-01-01T00:00:00+00:00",
      "updated-at": "2020-01-01T00:00:00+00:00",
      "deleted-at": null
    },
    "relationships": {
      "membership": {
        "data": {
          "type": "memberships",
          "id": "6jVhCt5kE2p6e7B7SX9CGe"
        }
      },
      "team": {
        "data": null
      },
      "email-id": {
        "data": {
          "type": "email-ids",
          "id": "97iQjGNFLTZ5oxfYTKinwo"
        }
      },
      "created-by": {
        "data": {
          "type": "memberships",
          "id": "C7xWERND6yBTpJJVHACzVf"
        }
      },
      "updated-by": {
        "data": {
          "type": "memberships",
          "id": "C7xWERND6yBTpJJVHACzVf"
        }
      },
      "deleted-by": {
        "data": null
      }
    }
  }
}

Delete Email ID Collaborator
DELETE`/email-ids/collaborators/`

Sets the is-archived field’s value to true. Note: The actual instance is not deleted.

Note: A membership cannot delete their own instance.

Example URI

DELETE https://api.omnigage.io/api/v1/email-ids/collaborators/

Response 204

Public Resources ¶

Public Account ¶

This resource manages retrieving public attributes of an account. This facilitates the following:

Does the account context exist? When attempting to retrieve this endpoint with an invalid account context, a coded error will be raised. This includes the following headers X-Account-ID, X-Account-Key and X-Terminal-ID.
Retrieving an account’s SSO URL.
Retrieving an account’s name, key and URL.

Retrieve Public Account
GET`/public-account`

Retrieve public account instance.

Example URI

GET https://api.omnigage.io/api/v1/public-account

Response 200

HideShow

Body

{
    "data": {
        "id": "RaF56o2r58hTKT7AYS9doj",
        "type": "accounts",
        "attributes": {
            "name": "Bell Labs",
            "key": "bell-labs",
            "url": "https://bell-labs.omnigage.io",
            "sso-is-enabled": true,
            "sso-url": 'https://api.omnigage.io/account/v1/authorize?account-id=RaF56o2r58hTKT7AYS9doj'
        }
    }
}

SSO Authorize ¶

This resource manages SSO redirects.

Retrieve SSO Authorize
GET`/sso-authorize{?account_id,relay_state}`

Request SSO authorize redirect.

The tokens that originated from this SSO authorization are only valid for this account and cannot be used with the Omnigage Identity API.

Note: If the identity provider specifies an email-address that is not a valid membership for the account, the user will be redirected to https://{account-key}.omnigage.io/membership-not-found. This will disregard relay-state.

Example URI

GET https://api.omnigage.io/api/v1/sso-authorize?account_id=&relay_state=

URI Parameters

HideShow

account_id: string (required)
Account ID to perform the SSO redirect for. If the account is not valid or does not have SSO confirmed, a coded error will be raised with a 400 HTTP status code.
relay_state: string (optional)
Once the SSO handshake is complete, the browser will be redirected to the URL appended to relay_state. On the final redirect, a parameter token={oauth2-bearer-access-token} is appended for the client to retrieve for subsequent authentication. If no relay state is provided, the final redirect will be to the account’s URL. Note: Must be a URL with HTTPS.

Response 302

Confirm Email ID ¶

This resource is used to confirm an email id. When a new email id is created, a confirmation email is automatically sent with a URL that includes the email id and the confirmation token.

Using Confirmation Token
PATCH`/confirm-email-ids/`

Example URI

PATCH https://api.omnigage.io/api/v1/confirm-email-ids/

Request

HideShow

Body

{
  "data": {
    "id": "GMrUFPh4QA7fRb59KARouJ",
    "type": "confirm-email-ids",
    "attributes": {
      "confirmation-token": "sTw5SGuOqNyYH8cIuH3oj5xsBHT3fxBZ5Zcd8bmLz6gbh1H3zlvBUygHcHgPt3S"
    }
  }
}

Response 200

Phone Resources ¶

Purchasable Phone Number Collection ¶

This resource provides querying of the purchasable phone numbers collection.

Retrieve Purchasable Phone Number
GET`/purchasable-phone-numbers/{iso_country}{?filter}`

Retrieve a collection of purchasable phone numbers.

Example URI

GET https://api.omnigage.io/api/v1/purchasable-phone-numbers/iso_country?filter=

URI Parameters

HideShow

iso_country

string (required)

ISO country code to filter by.

Choices: US CA

filter

string (optional)

Filter on one or more fields using comma separated values filter[field]=1,2. Use filter[service-profile.id] to filter by service profile.

Response 200

HideShow

Body

{
  "links": {
    "self": "/purchasable-phone-numbers/US",
    "next": "/purchasable-phone-numbers/US",
    "last": "/purchasable-phone-numbers/US"
  },
  "meta": {
    "total": 10
  },
  "data": [
    {
      "id": "5105551234",
      "type": "purchasable-phone-numbers",
      "attributes": {
        "phone-number": "+5105551234",
        "iso-country": "US",
        "postal-code": "32801",
        "region": "FL",
        "city": "Orlando",
        "latitude": "28.5409",
        "longitude": "-81.381",
        "is-voice-enabled": true,
        "is-text-sms-enabled": true,
        "is-text-mms-enabled": true
      },
      "relationships": {
        "service-profile": {
          "data": {
            "type": "service-profiles",
            "id": "yxLyyftrAUNWu4qhvefnrf"
          }
        }
      }
    }
  ]
}

Phone Number Collection ¶

This resource manages the retrieval of phone number collections and the creation of phone number instances.

Retrieve Phone Numbers
GET`/phone-numbers{?include,filter,sort,page}`

Retrieve a collection of phone numbers.

Example URI

GET https://api.omnigage.io/api/v1/phone-numbers?include=&filter=1&sort=created-at&page=10

URI Parameters

HideShow

include: string (optional)
Include one ore more related relationships using comma separated name.
sort: string (optional) Example: created-at
Sort on one or more fields using comma separated values.
filter: string (optional) Example: 1
Filter on one or more fields using comma separated values filter[field]=1,2.
page: string (optional) Example: 10
Use page[limit]=10 to reduce the number of instances returned. Use ?page[offset]=10 to skip this many instances.

Response 200

HideShow

Body

{
  "links": {
    "self": "/phone-numbers",
    "next": "/phone-numbers?page[offset]=10",
    "last": "/phone-numbers?page[offset]=100"
  },
  "meta": {
    "total": 110
  },
  "data": [
    {
      "id": "C8pd8zmNeCCydUAaXXaQZ4",
      "type": "phone-numbers",
      "attributes": {
        "label": "Headquarters",
        "phone-number": "+15197566220",
        "inbound-default-kind": "conference",
        "inbound-default-forward-to-phone-number": null,
        "inbound-default-forward-pause": 0,
        "inbound-default-is-to-notify": false,
        "inbound-default-conference-pin": null,
        "is-voice-enabled": true,
        "is-text-sms-enabled": true,
        "is-text-mms-enabled": true,
        "is-archived": false,
        "created-at": "2020-01-01T00:00:00+00:00",
        "updated-at": "2020-01-01T00:00:00+00:00",
        "deleted-at": null
      },
      "relationships": {
        "caller-id": {
          "data": {
            "type": "caller-ids",
            "id": "WAhJUimwmF72Zmfe5p9sUm"
          }
        },
        "inbound-default-conference": {
          "data": {
            "type": "conferences",
            "id": "zYhkWhgc39RwuRwipDtEnf"
          }
        },
        "inbound-default-conference-greeting": {
          "data": {
            "type": "voice-templates",
            "id": "CF8xUWscWUBTqqMvNTx2xi"
          }
        },
        "created-by": {
          "data": {
            "type": "memberships",
            "id": "C7xWERND6yBTpJJVHACzVf"
          }
        },
        "updated-by": {
          "data": {
            "type": "memberships",
            "id": "C7xWERND6yBTpJJVHACzVf"
          }
        },
        "deleted-by": {
          "data": null
        }
      }
    }
  ]
}

Create Phone Number
POST`/phone-numbers`

Create a new phone number instance.

Note: The phone-number must be a valid number from the purchasable-phone-numbers resource. A caller-id is created matching this number.

Example URI

POST https://api.omnigage.io/api/v1/phone-numbers

Request

HideShow

Body

{
  "data": {
    "type": "phone-numbers",
    "attributes": {
      "label": "Headquarters",
      "phone-number": "+15197566220"
    }
  }
}

Response 201

HideShow

Body

{
  "data": {
    "id": "C8pd8zmNeCCydUAaXXaQZ4",
    "type": "phone-numbers",
    "attributes": {
      "label": "Headquarters",
      "phone-number": "+15197566220",
      "inbound-default-kind": "conference",
      "inbound-default-forward-to-phone-number": null,
      "inbound-default-forward-pause": 0,
      "inbound-default-is-to-notify": false,
      "inbound-default-conference-pin": null,
      "is-voice-enabled": true,
      "is-text-sms-enabled": true,
      "is-text-mms-enabled": true,
      "is-archived": false,
      "created-at": "2020-01-01T00:00:00+00:00",
      "updated-at": "2020-01-01T00:00:00+00:00",
      "deleted-at": null
    },
    "relationships": {
      "caller-id": {
        "data": {
          "type": "caller-ids",
          "id": "WAhJUimwmF72Zmfe5p9sUm"
        }
      },
      "inbound-default-conference": {
        "data": {
          "type": "conferences",
          "id": "zYhkWhgc39RwuRwipDtEnf"
        }
      },
      "inbound-default-conference-greeting": {
        "data": {
          "type": "voice-templates",
          "id": "CF8xUWscWUBTqqMvNTx2xi"
        }
      },
      "created-by": {
        "data": {
          "type": "memberships",
          "id": "C7xWERND6yBTpJJVHACzVf"
        }
      },
      "updated-by": {
        "data": {
          "type": "memberships",
          "id": "C7xWERND6yBTpJJVHACzVf"
        }
      },
      "deleted-by": {
        "data": null
      }
    }
  }
}

Phone Number ¶

This resource manages updating, retrieving and deleting a specified phone number instance.

Retrieve Phone Number
GET`/phone-numbers/`

Retrieve an existing phone number instance.

Example URI

GET https://api.omnigage.io/api/v1/phone-numbers/

Response 200

HideShow

Body

{
  "data": {
    "id": "C8pd8zmNeCCydUAaXXaQZ4",
    "type": "phone-numbers",
    "attributes": {
      "label": "Headquarters",
      "phone-number": "+15197566220",
      "inbound-default-kind": "conference",
      "inbound-default-forward-to-phone-number": null,
      "inbound-default-forward-pause": 0,
      "inbound-default-is-to-notify": false,
      "inbound-default-conference-pin": null,
      "is-voice-enabled": true,
      "is-text-sms-enabled": true,
      "is-text-mms-enabled": true,
      "is-archived": false,
      "created-at": "2020-01-01T00:00:00+00:00",
      "updated-at": "2020-01-01T00:00:00+00:00",
      "deleted-at": null
    },
    "relationships": {
      "caller-id": {
        "data": {
          "type": "caller-ids",
          "id": "WAhJUimwmF72Zmfe5p9sUm"
        }
      },
      "inbound-default-conference": {
        "data": {
          "type": "conferences",
          "id": "zYhkWhgc39RwuRwipDtEnf"
        }
      },
      "inbound-default-conference-greeting": {
        "data": {
          "type": "voice-templates",
          "id": "CF8xUWscWUBTqqMvNTx2xi"
        }
      },
      "created-by": {
        "data": {
          "type": "memberships",
          "id": "C7xWERND6yBTpJJVHACzVf"
        }
      },
      "updated-by": {
        "data": {
          "type": "memberships",
          "id": "C7xWERND6yBTpJJVHACzVf"
        }
      },
      "deleted-by": {
        "data": null
      }
    }
  }
}

Update Phone Number
PATCH`/phone-numbers/`

Update an existing phone number instance.

Example URI

PATCH https://api.omnigage.io/api/v1/phone-numbers/

Request

HideShow

Body

{
  "data": {
    "id": "C8pd8zmNeCCydUAaXXaQZ4",
    "type": "phone-numbers",
    "attributes": {
      "label": "Headquarters",
      "phone-number": "+15197566220",
      "inbound-default-kind": "conference",
      "inbound-default-forward-to-phone-number": null,
      "inbound-default-forward-pause": 0,
      "inbound-default-is-to-notify": false,
      "inbound-default-conference-pin": null,
      "is-voice-enabled": true,
      "is-text-sms-enabled": true,
      "is-text-mms-enabled": true,
      "is-archived": false,
      "created-at": "2020-01-01T00:00:00+00:00",
      "updated-at": "2020-01-01T00:00:00+00:00",
      "deleted-at": null
    },
    "relationships": {
      "caller-id": {
        "data": {
          "type": "caller-ids",
          "id": "WAhJUimwmF72Zmfe5p9sUm"
        }
      },
      "inbound-default-conference": {
        "data": {
          "type": "conferences",
          "id": "zYhkWhgc39RwuRwipDtEnf"
        }
      },
      "inbound-default-conference-greeting": {
        "data": {
          "type": "voice-templates",
          "id": "CF8xUWscWUBTqqMvNTx2xi"
        }
      },
      "created-by": {
        "data": {
          "type": "memberships",
          "id": "C7xWERND6yBTpJJVHACzVf"
        }
      },
      "updated-by": {
        "data": {
          "type": "memberships",
          "id": "C7xWERND6yBTpJJVHACzVf"
        }
      },
      "deleted-by": {
        "data": null
      }
    }
  }
}

Response 202

HideShow

Body

{
  "data": {
    "id": "C8pd8zmNeCCydUAaXXaQZ4",
    "type": "phone-numbers",
    "attributes": {
      "label": "Headquarters",
      "phone-number": "+15197566220",
      "inbound-default-kind": "conference",
      "inbound-default-forward-to-phone-number": null,
      "inbound-default-forward-pause": 0,
      "inbound-default-is-to-notify": false,
      "inbound-default-conference-pin": null,
      "is-voice-enabled": true,
      "is-text-sms-enabled": true,
      "is-text-mms-enabled": true,
      "is-archived": false,
      "created-at": "2020-01-01T00:00:00+00:00",
      "updated-at": "2020-01-01T00:00:00+00:00",
      "deleted-at": null
    },
    "relationships": {
      "caller-id": {
        "data": {
          "type": "caller-ids",
          "id": "WAhJUimwmF72Zmfe5p9sUm"
        }
      },
      "inbound-default-conference": {
        "data": {
          "type": "conferences",
          "id": "zYhkWhgc39RwuRwipDtEnf"
        }
      },
      "inbound-default-conference-greeting": {
        "data": {
          "type": "voice-templates",
          "id": "CF8xUWscWUBTqqMvNTx2xi"
        }
      },
      "created-by": {
        "data": {
          "type": "memberships",
          "id": "C7xWERND6yBTpJJVHACzVf"
        }
      },
      "updated-by": {
        "data": {
          "type": "memberships",
          "id": "C7xWERND6yBTpJJVHACzVf"
        }
      },
      "deleted-by": {
        "data": null
      }
    }
  }
}

Delete Phone Number
DELETE`/phone-numbers/`

Sets the is-archived field’s value to true. Note: The actual instance is not deleted.

A phone-number can be unarchived within a seven day period.
Archiving a phone-number will implicitly archive it’s related caller-id.

Example URI

DELETE https://api.omnigage.io/api/v1/phone-numbers/

Response 204

Phone Number Collaborator Collection ¶

This resource manages the retrieval of collaborator collections and the creation of collaborator instances.

Retrieve Phone Number Collaborators
GET`/phone-numbers/collaborators{?include,sort,filter,page}`

Retrieve a collection of collaborators.

Example URI

GET https://api.omnigage.io/api/v1/phone-numbers/collaborators?include=&sort=created-at&filter=1&page=10

URI Parameters

HideShow

include: string (optional)
Include one ore more related relationships using comma separated name.
sort: string (optional) Example: created-at
Sort on one or more fields using comma separated values.
filter: string (optional) Example: 1
Filter on one or more fields using comma separated values filter[field]=1,2.
page: string (optional) Example: 10
Use page[limit]=10 to reduce the number of instances returned. Use ?page[offset]=10 to skip this many instances.

Response 200

HideShow

Body

{
  "links": {
    "self": "/phone-numbers/97iQjGNFLTZ5oxfYTKinwo/collaborators",
    "next": "/phone-numbers/97iQjGNFLTZ5oxfYTKinwo/collaborators?page[offset]=10",
    "last": "/phone-numbers/97iQjGNFLTZ5oxfYTKinwo/collaborators?page[offset]=100"
  },
  "meta": {
    "total": 1
  },
  "data": [
    {
      "id": "RaF56o2r58hTKT7AYS9doj",
      "type": "phone-numbers-collaborators",
      "attributes": {
        "permission": "write",
        "is-archived": false,
        "created-at": "2020-01-01T00:00:00+00:00",
        "updated-at": "2020-01-01T00:00:00+00:00",
        "deleted-at": null
      },
      "relationships": {
        "membership": {
          "data": {
            "type": "memberships",
            "id": "6jVhCt5kE2p6e7B7SX9CGe"
          }
        },
        "team": {
          "data": null
        },
        "phone-number": {
          "data": {
            "type": "phone-numbers",
            "id": "97iQjGNFLTZ5oxfYTKinwo"
          }
        },
        "created-by": {
          "data": {
            "type": "memberships",
            "id": "C7xWERND6yBTpJJVHACzVf"
          }
        },
        "updated-by": {
          "data": {
            "type": "memberships",
            "id": "C7xWERND6yBTpJJVHACzVf"
          }
        },
        "deleted-by": {
          "data": null
        }
      }
    }
  ]
}

Create Phone Number Collaborator
POST`/phone-numbers/collaborators`

Create a new collaborator instance.

Example URI

POST https://api.omnigage.io/api/v1/phone-numbers/collaborators

Request

HideShow

Body

{
  "data": {
    "type": "phone-numbers-collaborators",
    "attributes": {
      "permission": "write"
    },
    "relationships": {
      "membership": {
        "data": {
          "type": "memberships",
          "id": "6jVhCt5kE2p6e7B7SX9CGe"
        }
      },
      "phone-number": {
        "data": {
          "type": "phone-numbers",
          "id": "97iQjGNFLTZ5oxfYTKinwo"
        }
      }
    }
  }
}

Response 201

HideShow

Body

{
  "data": {
    "id": "RaF56o2r58hTKT7AYS9doj",
    "type": "phone-numbers-collaborators",
    "attributes": {
      "permission": "write",
      "is-archived": false,
      "created-at": "2020-01-01T00:00:00+00:00",
      "updated-at": "2020-01-01T00:00:00+00:00",
      "deleted-at": null
    },
    "relationships": {
      "membership": {
        "data": {
          "type": "memberships",
          "id": "6jVhCt5kE2p6e7B7SX9CGe"
        }
      },
      "team": {
        "data": null
      },
      "phone-number": {
        "data": {
          "type": "phone-numbers",
          "id": "97iQjGNFLTZ5oxfYTKinwo"
        }
      },
      "created-by": {
        "data": {
          "type": "memberships",
          "id": "C7xWERND6yBTpJJVHACzVf"
        }
      },
      "updated-by": {
        "data": {
          "type": "memberships",
          "id": "C7xWERND6yBTpJJVHACzVf"
        }
      },
      "deleted-by": {
        "data": null
      }
    }
  }
}

Phone Number Collaborator ¶

This resource manages updating and retrieving a specified collaborator instance.

Retrieve Phone Number Collaborator
GET`/phone-numbers/collaborators/`

Retrieve an existing collaborator instance.

Example URI

GET https://api.omnigage.io/api/v1/phone-numbers/collaborators/

Response 200

HideShow

Body

{
  "data": {
    "id": "RaF56o2r58hTKT7AYS9doj",
    "type": "phone-numbers-collaborators",
    "attributes": {
      "permission": "write",
      "is-archived": false,
      "created-at": "2020-01-01T00:00:00+00:00",
      "updated-at": "2020-01-01T00:00:00+00:00",
      "deleted-at": null
    },
    "relationships": {
      "membership": {
        "data": {
          "type": "memberships",
          "id": "6jVhCt5kE2p6e7B7SX9CGe"
        }
      },
      "team": {
        "data": null
      },
      "phone-number": {
        "data": {
          "type": "phone-numbers",
          "id": "97iQjGNFLTZ5oxfYTKinwo"
        }
      },
      "created-by": {
        "data": {
          "type": "memberships",
          "id": "C7xWERND6yBTpJJVHACzVf"
        }
      },
      "updated-by": {
        "data": {
          "type": "memberships",
          "id": "C7xWERND6yBTpJJVHACzVf"
        }
      },
      "deleted-by": {
        "data": null
      }
    }
  }
}

Update Phone Number Collaborator
PATCH`/phone-numbers/collaborators/`

Update an existing collaborator instance.

Note: A membership cannot edit their own instance.

Example URI

PATCH https://api.omnigage.io/api/v1/phone-numbers/collaborators/

Request

HideShow

Body

{
  "data": {
    "id": "RaF56o2r58hTKT7AYS9doj",
    "type": "phone-numbers-collaborators",
    "attributes": {
      "permission": "write",
      "is-archived": false,
      "created-at": "2020-01-01T00:00:00+00:00",
      "updated-at": "2020-01-01T00:00:00+00:00",
      "deleted-at": null
    },
    "relationships": {
      "membership": {
        "data": {
          "type": "memberships",
          "id": "6jVhCt5kE2p6e7B7SX9CGe"
        }
      },
      "team": {
        "data": null
      },
      "phone-number": {
        "data": {
          "type": "phone-numbers",
          "id": "97iQjGNFLTZ5oxfYTKinwo"
        }
      },
      "created-by": {
        "data": {
          "type": "memberships",
          "id": "C7xWERND6yBTpJJVHACzVf"
        }
      },
      "updated-by": {
        "data": {
          "type": "memberships",
          "id": "C7xWERND6yBTpJJVHACzVf"
        }
      },
      "deleted-by": {
        "data": null
      }
    }
  }
}

Response 202

HideShow

Body

{
  "data": {
    "id": "RaF56o2r58hTKT7AYS9doj",
    "type": "phone-numbers-collaborators",
    "attributes": {
      "permission": "write",
      "is-archived": false,
      "created-at": "2020-01-01T00:00:00+00:00",
      "updated-at": "2020-01-01T00:00:00+00:00",
      "deleted-at": null
    },
    "relationships": {
      "membership": {
        "data": {
          "type": "memberships",
          "id": "6jVhCt5kE2p6e7B7SX9CGe"
        }
      },
      "team": {
        "data": null
      },
      "phone-number": {
        "data": {
          "type": "phone-numbers",
          "id": "97iQjGNFLTZ5oxfYTKinwo"
        }
      },
      "created-by": {
        "data": {
          "type": "memberships",
          "id": "C7xWERND6yBTpJJVHACzVf"
        }
      },
      "updated-by": {
        "data": {
          "type": "memberships",
          "id": "C7xWERND6yBTpJJVHACzVf"
        }
      },
      "deleted-by": {
        "data": null
      }
    }
  }
}

Delete Phone Number Collaborator
DELETE`/phone-numbers/collaborators/`

Sets the is-archived field’s value to true. Note: The actual instance is not deleted.

Note: A membership cannot delete their own instance.

Example URI

DELETE https://api.omnigage.io/api/v1/phone-numbers/collaborators/

Response 204

Port Request Collection ¶

This resource manages the retrieval of port request collections and the creation of port request instances.

Note: Only accessible by account admins.

Retrieve Port Requests
GET`/port-requests{?include,filter,sort,page}`

Retrieve a collection of port requests.

Example URI

GET https://api.omnigage.io/api/v1/port-requests?include=&filter=1&sort=created-at&page=10

URI Parameters

HideShow

include: string (optional)
Include one ore more related relationships using comma separated name.
sort: string (optional) Example: created-at
Sort on one or more fields using comma separated values.
filter: string (optional) Example: 1
Filter on one or more fields using comma separated values filter[field]=1,2.
page: string (optional) Example: 10
Use page[limit]=10 to reduce the number of instances returned. Use ?page[offset]=10 to skip this many instances.

Response 200

HideShow

Body

{
    "links": {
        "self": "/port-requests",
        "next": "/port-requests?page[offset]=10",
        "last": "/port-requests?page[offset]=100"
    },
    "meta": {
        "total": 10
    },
    "data": [{
        "id": "RaF56o2r58hTKT7AYS9doj",
        "type": "port-requests",
        "attributes": {
            "label": "(519)756-6220",
            "status": "pending",
            "company": "Bell Labs, Inc.",
            "first-name": "Alexander",
            "last-name": "Bell",
            "billing-phone-number": "+15197566220",
            "billing-address-line1-number": "463",
            "billing-address-line1-name": "West Street",
            "billing-address-line2": null,
            "billing-address-city": "New York"
            "billing-address-state": "NY",
            "billing-address-zip": "10014",
            "pin-phone-numbers": [
                {
                    "phone-number": "+15197566220",
                    "account-number": "2874745",
                    "pin": "8495"
                }
            ],
            "phone-number": [
                "+15190123456",
                "+15191234567"
            ],
            "is-archived": false,
            "created-at": "2020-01-01T00:00:00+00:00",
            "updated-at": "2020-01-01T00:00:00+00:00"
        },
        "relationships": {
            "billing-address-country": {
                "data": {"type": "countries", "id": "2DsmzGyeGcoubEubCBxN5F"}
            },
            "upload-authorization": {
                "data": null
            },
            "upload-billing-statements": {
                "data": []
            },
            "authorization": {
                "data": {"type": "files", "id": "ReN6UbN4zgaWfvFSM8csUZ"}
            },
            "billing-statements": {
                "data": [
                    {"type": "files", "id": "xrWvAqH42mVgNskNci4tuf"}
                ]
            },
            "created-by": {
                "data": {"type": "memberships", "id": "C7xWERND6yBTpJJVHACzVf"}
            },
            "updated-by": {
                "data": {"type": "memberships", "id": "C7xWERND6yBTpJJVHACzVf"}
            }
        }
    }]
}

Create Port Request
POST`/port-requests`

Create a new port request instance.

Example URI

POST https://api.omnigage.io/api/v1/port-requests

Request

HideShow

Body

{
    "data": {
        "type": "port-requests",
        "attributes": {
            "label": "(519)756-6220",
            "company": "Bell Labs, Inc.",
            "first-name": "Alexander",
            "last-name": "Bell",
            "billing-phone-number": "+15197566220",
            "billing-address-line1-number": "463",
            "billing-address-line1-name": "West Street",
            "billing-address-line2": null,
            "billing-address-city": "New York"
            "billing-address-state": "NY",
            "billing-address-zip": "10014",
            "pin-phone-numbers": [
                {
                    "phone-number": "+15197566220",
                    "account-number": "2874745",
                    "pin": "8495"
                }
            ],
            "phone-number": [
                "+15190123456",
                "+15191234567"
            ]
        },
        "relationships": {
            "billing-address-country": {
                "data": {"type": "countries", "id": "2DsmzGyeGcoubEubCBxN5F"}
            },
            "upload-authorization": {
                "data": {"type": "uploads", "id": "9kQs8DntN6WUddyZmEqxne"}
            },
            "upload-billing-statements": {
                "data": [
                    {"type": "uploads", "id": "3WSToxawgDgEWvGA35eX99"}
                ]
            }
        }
    }
}

Response 201

HideShow

Body

{
    "data": {
        "id": "RaF56o2r58hTKT7AYS9doj",
        "type": "port-requests",
        "attributes": {
            "label": "(519)756-6220",
            "status": "pending",
            "company": "Bell Labs, Inc.",
            "first-name": "Alexander",
            "last-name": "Bell",
            "billing-phone-number": "+15197566220",
            "billing-address-line1-number": "463",
            "billing-address-line1-name": "West Street",
            "billing-address-line2": null,
            "billing-address-city": "New York"
            "billing-address-state": "NY",
            "billing-address-zip": "10014",
            "pin-phone-numbers": [
                {
                    "phone-number": "+15197566220",
                    "account-number": "2874745",
                    "pin": "8495"
                }
            ],
            "phone-number": [
                "+15190123456",
                "+15191234567"
            ],
            "is-archived": false,
            "created-at": "2020-01-01T00:00:00+00:00",
            "updated-at": "2020-01-01T00:00:00+00:00"
        },
        "relationships": {
            "billing-address-country": {
                "data": {"type": "countries", "id": "2DsmzGyeGcoubEubCBxN5F"}
            },
            "upload-authorization": {
                "data": null
            },
            "upload-billing-statements": {
                "data": []
            },
            "authorization": {
                "data": {"type": "files", "id": "ReN6UbN4zgaWfvFSM8csUZ"}
            },
            "billing-statements": {
                "data": [
                    {"type": "files", "id": "xrWvAqH42mVgNskNci4tuf"}
                ]
            },
            "created-by": {
                "data": {"type": "memberships", "id": "C7xWERND6yBTpJJVHACzVf"}
            },
            "updated-by": {
                "data": {"type": "memberships", "id": "C7xWERND6yBTpJJVHACzVf"}
            }
        }
    }

Port Request ¶

This resource manages updating and retrieving a specified port request instance.

Retrieve Port Request
GET`/port-requests/`

Retrieve an existing port request instance.

Example URI

GET https://api.omnigage.io/api/v1/port-requests/

Response 200

HideShow

Body

{
    "data": {
        "id": "RaF56o2r58hTKT7AYS9doj",
        "type": "port-requests",
        "attributes": {
            "label": "(519)756-6220",
            "status": "pending",
            "company": "Bell Labs, Inc.",
            "first-name": "Alexander",
            "last-name": "Bell",
            "billing-phone-number": "+15197566220",
            "billing-address-line1-number": "463",
            "billing-address-line1-name": "West Street",
            "billing-address-line2": null,
            "billing-address-city": "New York"
            "billing-address-state": "NY",
            "billing-address-zip": "10014",
            "pin-phone-numbers": [
                {
                    "phone-number": "+15197566220",
                    "account-number": "2874745",
                    "pin": "8495"
                }
            ],
            "phone-number": [
                "+15190123456",
                "+15191234567"
            ],
            "is-archived": false,
            "created-at": "2020-01-01T00:00:00+00:00",
            "updated-at": "2020-01-01T00:00:00+00:00"
        },
        "relationships": {
            "billing-address-country": {
                "data": {"type": "countries", "id": "2DsmzGyeGcoubEubCBxN5F"}
            },
            "upload-authorization": {
                "data": null
            },
            "upload-billing-statements": {
                "data": []
            },
            "authorization": {
                "data": {"type": "files", "id": "ReN6UbN4zgaWfvFSM8csUZ"}
            },
            "billing-statements": {
                "data": [
                    {"type": "files", "id": "xrWvAqH42mVgNskNci4tuf"}
                ]
            },
            "created-by": {
                "data": {"type": "memberships", "id": "C7xWERND6yBTpJJVHACzVf"}
            },
            "updated-by": {
                "data": {"type": "memberships", "id": "C7xWERND6yBTpJJVHACzVf"}
            }
        }
    }

Update Port Request
PATCH`/port-requests/`

Update an existing port request instance.

Note: A port request can only be updated when the status is pending.

Example URI

PATCH https://api.omnigage.io/api/v1/port-requests/

Request

HideShow

Body

{
    "data": {
        "id": "RaF56o2r58hTKT7AYS9doj",
        "type": "port-requests",
        "attributes": {
            "label": "(519)756-6220",
            "status": "pending",
            "company": "Bell Labs, Inc.",
            "first-name": "Alexander",
            "last-name": "Bell",
            "billing-phone-number": "+15197566220",
            "billing-address-line1-number": "463",
            "billing-address-line1-name": "West Street",
            "billing-address-line2": null,
            "billing-address-city": "New York"
            "billing-address-state": "NY",
            "billing-address-zip": "10014",
            "pin-phone-numbers": [
                {
                    "phone-number": "+15197566220",
                    "account-number": "2874745",
                    "pin": "8495"
                }
            ],
            "phone-number": [
                "+15190123456",
                "+15191234567"
            ],
            "is-archived": false,
            "created-at": "2020-01-01T00:00:00+00:00",
            "updated-at": "2020-01-01T00:00:00+00:00"
        },
        "relationships": {
            "billing-address-country": {
                "data": {"type": "countries", "id": "2DsmzGyeGcoubEubCBxN5F"}
            },
            "upload-authorization": {
                "data": null
            },
            "upload-billing-statements": {
                "data": []
            },
            "authorization": {
                "data": {"type": "files", "id": "ReN6UbN4zgaWfvFSM8csUZ"}
            },
            "billing-statements": {
                "data": [
                    {"type": "files", "id": "xrWvAqH42mVgNskNci4tuf"}
                ]
            },
            "created-by": {
                "data": {"type": "memberships", "id": "C7xWERND6yBTpJJVHACzVf"}
            },
            "updated-by": {
                "data": {"type": "memberships", "id": "C7xWERND6yBTpJJVHACzVf"}
            }
        }
    }

Response 202

HideShow

Body

{
    "data": {
        "id": "RaF56o2r58hTKT7AYS9doj",
        "type": "port-requests",
        "attributes": {
            "label": "(519)756-6220",
            "status": "pending",
            "company": "Bell Labs, Inc.",
            "first-name": "Alexander",
            "last-name": "Bell",
            "billing-phone-number": "+15197566220",
            "billing-address-line1-number": "463",
            "billing-address-line1-name": "West Street",
            "billing-address-line2": null,
            "billing-address-city": "New York"
            "billing-address-state": "NY",
            "billing-address-zip": "10014",
            "pin-phone-numbers": [
                {
                    "phone-number": "+15197566220",
                    "account-number": "2874745",
                    "pin": "8495"
                }
            ],
            "phone-number": [
                "+15190123456",
                "+15191234567"
            ],
            "is-archived": false,
            "created-at": "2020-01-01T00:00:00+00:00",
            "updated-at": "2020-01-01T00:00:00+00:00"
        },
        "relationships": {
            "billing-address-country": {
                "data": {"type": "countries", "id": "2DsmzGyeGcoubEubCBxN5F"}
            },
            "upload-authorization": {
                "data": null
            },
            "upload-billing-statements": {
                "data": []
            },
            "authorization": {
                "data": {"type": "files", "id": "ReN6UbN4zgaWfvFSM8csUZ"}
            },
            "billing-statements": {
                "data": [
                    {"type": "files", "id": "xrWvAqH42mVgNskNci4tuf"}
                ]
            },
            "created-by": {
                "data": {"type": "memberships", "id": "C7xWERND6yBTpJJVHACzVf"}
            },
            "updated-by": {
                "data": {"type": "memberships", "id": "C7xWERND6yBTpJJVHACzVf"}
            }
        }
    }

Delete Port Request
DELETE`/port-requests/`

Cancels the port request.

Note: The actual instance is not deleted and is-archived will be set to true.

Example URI

DELETE https://api.omnigage.io/api/v1/port-requests/

Response 204

Conference Collection ¶

This resource manages the retrieval of conference collections and the creation of conference instances.

Retrieve Conferences
GET`/conferences{?include,filter,sort,page}`

Retrieve a collection of conferences.

Example URI

GET https://api.omnigage.io/api/v1/conferences?include=&filter=1&sort=created-at&page=10

URI Parameters

HideShow

include: string (optional)
Include one ore more related relationships using comma separated name.
sort: string (optional) Example: created-at
Sort on one or more fields using comma separated values.
filter: string (optional) Example: 1
Filter on one or more fields using comma separated values filter[field]=1,2.
page: string (optional) Example: 10
Use page[limit]=10 to reduce the number of instances returned. Use ?page[offset]=10 to skip this many instances.

Response 200

HideShow

Body

{
  "links": {
    "self": "/conferences",
    "next": "/conferences?page[offset]=10",
    "last": "/conferences?page[offset]=100"
  },
  "meta": {
    "total": 110
  },
  "data": [
    {
      "id": "C8pd8zmNeCCydUAaXXaQZ4",
      "type": "conferences",
      "attributes": {
        "label": "Headquarters",
        "beep-on-enter": true,
        "beep-on-exit": true,
        "play-hold-music": true,
        "max-participants": null,
        "is-archived": false,
        "created-at": "2020-01-01T00:00:00+00:00",
        "updated-at": "2020-01-01T00:00:00+00:00",
        "deleted-at": null
      },
      "relationships": {
        "created-by": {
          "data": {
            "type": "memberships",
            "id": "C7xWERND6yBTpJJVHACzVf"
          }
        },
        "updated-by": {
          "data": {
            "type": "memberships",
            "id": "C7xWERND6yBTpJJVHACzVf"
          }
        },
        "deleted-by": {
          "data": null
        }
      }
    }
  ]
}

Create Conference
POST`/conferences`

Create a new conference instance.

Example URI

POST https://api.omnigage.io/api/v1/conferences

Request

HideShow

Body

{
  "data": {
    "type": "conferences",
    "attributes": {
      "label": "Headquarters"
    }
  }
}

Response 201

HideShow

Body

{
  "data": {
    "id": "C8pd8zmNeCCydUAaXXaQZ4",
    "type": "conferences",
    "attributes": {
      "label": "Headquarters",
      "beep-on-enter": true,
      "beep-on-exit": true,
      "play-hold-music": true,
      "max-participants": null,
      "is-archived": false,
      "created-at": "2020-01-01T00:00:00+00:00",
      "updated-at": "2020-01-01T00:00:00+00:00",
      "deleted-at": null
    },
    "relationships": {
      "created-by": {
        "data": {
          "type": "memberships",
          "id": "C7xWERND6yBTpJJVHACzVf"
        }
      },
      "updated-by": {
        "data": {
          "type": "memberships",
          "id": "C7xWERND6yBTpJJVHACzVf"
        }
      },
      "deleted-by": {
        "data": null
      }
    }
  }
}

Conference ¶

This resource manages updating, retrieving and deleting a specified conference instance.

Retrieve Conference
GET`/conferences/`

Retrieve an existing conference instance.

Example URI

GET https://api.omnigage.io/api/v1/conferences/

Response 200

HideShow

Body

{
  "data": {
    "id": "C8pd8zmNeCCydUAaXXaQZ4",
    "type": "conferences",
    "attributes": {
      "label": "Headquarters",
      "beep-on-enter": true,
      "beep-on-exit": true,
      "play-hold-music": true,
      "max-participants": null,
      "is-archived": false,
      "created-at": "2020-01-01T00:00:00+00:00",
      "updated-at": "2020-01-01T00:00:00+00:00",
      "deleted-at": null
    },
    "relationships": {
      "created-by": {
        "data": {
          "type": "memberships",
          "id": "C7xWERND6yBTpJJVHACzVf"
        }
      },
      "updated-by": {
        "data": {
          "type": "memberships",
          "id": "C7xWERND6yBTpJJVHACzVf"
        }
      },
      "deleted-by": {
        "data": null
      }
    }
  }
}

Update Conference
PATCH`/conferences/`

Update an existing conference instance.

Example URI

PATCH https://api.omnigage.io/api/v1/conferences/

Request

HideShow

Body

{
  "data": {
    "id": "C8pd8zmNeCCydUAaXXaQZ4",
    "type": "conferences",
    "attributes": {
      "label": "Headquarters",
      "beep-on-enter": true,
      "beep-on-exit": true,
      "play-hold-music": true,
      "max-participants": null,
      "is-archived": false,
      "created-at": "2020-01-01T00:00:00+00:00",
      "updated-at": "2020-01-01T00:00:00+00:00",
      "deleted-at": null
    },
    "relationships": {
      "created-by": {
        "data": {
          "type": "memberships",
          "id": "C7xWERND6yBTpJJVHACzVf"
        }
      },
      "updated-by": {
        "data": {
          "type": "memberships",
          "id": "C7xWERND6yBTpJJVHACzVf"
        }
      },
      "deleted-by": {
        "data": null
      }
    }
  }
}

Response 202

HideShow

Body

{
  "data": {
    "id": "C8pd8zmNeCCydUAaXXaQZ4",
    "type": "conferences",
    "attributes": {
      "label": "Headquarters",
      "beep-on-enter": true,
      "beep-on-exit": true,
      "play-hold-music": true,
      "max-participants": null,
      "is-archived": false,
      "created-at": "2020-01-01T00:00:00+00:00",
      "updated-at": "2020-01-01T00:00:00+00:00",
      "deleted-at": null
    },
    "relationships": {
      "created-by": {
        "data": {
          "type": "memberships",
          "id": "C7xWERND6yBTpJJVHACzVf"
        }
      },
      "updated-by": {
        "data": {
          "type": "memberships",
          "id": "C7xWERND6yBTpJJVHACzVf"
        }
      },
      "deleted-by": {
        "data": null
      }
    }
  }
}

Delete Conference
DELETE`/conferences/`

Sets the is-archived field’s value to true. Note: The actual instance is not deleted.

Example URI

DELETE https://api.omnigage.io/api/v1/conferences/

Response 204

Conference Participant Collection ¶

This resource manages the retrieval of conference participant collections and the creation of participant instances.

Retrieve Conference Participants
GET`/conferences/participants{?include,sort,filter,page}`

Retrieve a collection of participants.

Example URI

GET https://api.omnigage.io/api/v1/conferences/participants?include=&sort=created-at&filter=1&page=10

URI Parameters

HideShow

include: string (optional)
Include one ore more related relationships using comma separated name.
sort: string (optional) Example: created-at
Sort on one or more fields using comma separated values.
filter: string (optional) Example: 1
Filter on one or more fields using comma separated values filter[field]=1,2.
page: string (optional) Example: 10
Use page[limit]=10 to reduce the number of instances returned. Use ?page[offset]=10 to skip this many instances.

Response 200

HideShow

Body

{
  "links": {
    "self": "/conferences/97iQjGNFLTZ5oxfYTKinwo/participants",
    "next": "/conferences/97iQjGNFLTZ5oxfYTKinwo/participants?page[offset]=10",
    "last": "/conferences/97iQjGNFLTZ5oxfYTKinwo/participants?page[offset]=100"
  },
  "meta": {
    "total": 1
  },
  "data": [
    {
      "id": "RaF56o2r58hTKT7AYS9doj",
      "type": "conferences-participants",
      "attributes": {
        "status": "completed",
        "is-muted": false,
        "created-at": "2020-01-01T00:00:00+00:00",
        "updated-at": "2020-01-01T00:00:00+00:00",
        "deleted-at": null
      },
      "relationships": {
        "conference": {
          "data": {
            "type": "conferences",
            "id": "97iQjGNFLTZ5oxfYTKinwo"
          }
        },
        "call": {
          "data": {
            "type": "calls",
            "id": "6jVhCt5kE2p6e7B7SX9CGe"
          }
        },
        "created-by": {
          "data": {
            "type": "memberships",
            "id": "C7xWERND6yBTpJJVHACzVf"
          }
        },
        "updated-by": {
          "data": {
            "type": "memberships",
            "id": "C7xWERND6yBTpJJVHACzVf"
          }
        },
        "deleted-by": {
          "data": null
        }
      }
    }
  ]
}

Create Conference Participant
POST`/conferences/participants`

Create a new participant instance.

Example URI

POST https://api.omnigage.io/api/v1/conferences/participants

Request

HideShow

Body

{
  "data": {
    "type": "conferences-participants",
    "relationships": {
      "conference": {
        "data": {
          "type": "conferences",
          "id": "97iQjGNFLTZ5oxfYTKinwo"
        }
      },
      "call": {
        "data": {
          "type": "calls",
          "id": "6jVhCt5kE2p6e7B7SX9CGe"
        }
      }
    }
  }
}

Response 201

HideShow

Body

{
  "data": {
    "id": "RaF56o2r58hTKT7AYS9doj",
    "type": "conferences-participants",
    "attributes": {
      "status": "completed",
      "is-muted": false,
      "created-at": "2020-01-01T00:00:00+00:00",
      "updated-at": "2020-01-01T00:00:00+00:00",
      "deleted-at": null
    },
    "relationships": {
      "conference": {
        "data": {
          "type": "conferences",
          "id": "97iQjGNFLTZ5oxfYTKinwo"
        }
      },
      "call": {
        "data": {
          "type": "calls",
          "id": "6jVhCt5kE2p6e7B7SX9CGe"
        }
      },
      "created-by": {
        "data": {
          "type": "memberships",
          "id": "C7xWERND6yBTpJJVHACzVf"
        }
      },
      "updated-by": {
        "data": {
          "type": "memberships",
          "id": "C7xWERND6yBTpJJVHACzVf"
        }
      },
      "deleted-by": {
        "data": null
      }
    }
  }
}

Conference Participant ¶

This resource manages updating and retrieving a specified conference participant instance.

Retrieve Conference Participant
GET`/conferences/participants/`

Retrieve an existing conference participant instance.

Example URI

GET https://api.omnigage.io/api/v1/conferences/participants/

Response 200

HideShow

Body

{
  "data": {
    "id": "RaF56o2r58hTKT7AYS9doj",
    "type": "conferences-participants",
    "attributes": {
      "status": "completed",
      "is-muted": false,
      "created-at": "2020-01-01T00:00:00+00:00",
      "updated-at": "2020-01-01T00:00:00+00:00",
      "deleted-at": null
    },
    "relationships": {
      "conference": {
        "data": {
          "type": "conferences",
          "id": "97iQjGNFLTZ5oxfYTKinwo"
        }
      },
      "call": {
        "data": {
          "type": "calls",
          "id": "6jVhCt5kE2p6e7B7SX9CGe"
        }
      },
      "created-by": {
        "data": {
          "type": "memberships",
          "id": "C7xWERND6yBTpJJVHACzVf"
        }
      },
      "updated-by": {
        "data": {
          "type": "memberships",
          "id": "C7xWERND6yBTpJJVHACzVf"
        }
      },
      "deleted-by": {
        "data": null
      }
    }
  }
}

Update Conference Participant
PATCH`/conferences/participants/`

Update an existing conference participant instance.

Example URI

PATCH https://api.omnigage.io/api/v1/conferences/participants/

Request

HideShow

Body

{
  "data": {
    "id": "RaF56o2r58hTKT7AYS9doj",
    "type": "conferences-participants",
    "attributes": {
      "status": "completed",
      "is-muted": false,
      "created-at": "2020-01-01T00:00:00+00:00",
      "updated-at": "2020-01-01T00:00:00+00:00",
      "deleted-at": null
    },
    "relationships": {
      "conference": {
        "data": {
          "type": "conferences",
          "id": "97iQjGNFLTZ5oxfYTKinwo"
        }
      },
      "call": {
        "data": {
          "type": "calls",
          "id": "6jVhCt5kE2p6e7B7SX9CGe"
        }
      },
      "created-by": {
        "data": {
          "type": "memberships",
          "id": "C7xWERND6yBTpJJVHACzVf"
        }
      },
      "updated-by": {
        "data": {
          "type": "memberships",
          "id": "C7xWERND6yBTpJJVHACzVf"
        }
      },
      "deleted-by": {
        "data": null
      }
    }
  }
}

Response 202

HideShow

Body

{
  "data": {
    "id": "RaF56o2r58hTKT7AYS9doj",
    "type": "conferences-participants",
    "attributes": {
      "status": "completed",
      "is-muted": false,
      "created-at": "2020-01-01T00:00:00+00:00",
      "updated-at": "2020-01-01T00:00:00+00:00",
      "deleted-at": null
    },
    "relationships": {
      "conference": {
        "data": {
          "type": "conferences",
          "id": "97iQjGNFLTZ5oxfYTKinwo"
        }
      },
      "call": {
        "data": {
          "type": "calls",
          "id": "6jVhCt5kE2p6e7B7SX9CGe"
        }
      },
      "created-by": {
        "data": {
          "type": "memberships",
          "id": "C7xWERND6yBTpJJVHACzVf"
        }
      },
      "updated-by": {
        "data": {
          "type": "memberships",
          "id": "C7xWERND6yBTpJJVHACzVf"
        }
      },
      "deleted-by": {
        "data": null
      }
    }
  }
}

Delete Conference Participant
DELETE`/conferences/participants/`

Removes the participant from the conference room. Note: The actual instance is not deleted.

Example URI

DELETE https://api.omnigage.io/api/v1/conferences/participants/

Response 204

Conference Collaborator Collection ¶

This resource manages the retrieval of collaborator collections and the creation of collaborator instances.

Retrieve Conference Collaborators
GET`/conferences/collaborators{?include,sort,filter,page}`

Retrieve a collection of collaborators.

Example URI

GET https://api.omnigage.io/api/v1/conferences/collaborators?include=&sort=created-at&filter=1&page=10

URI Parameters

HideShow

include: string (optional)
Include one ore more related relationships using comma separated name.
sort: string (optional) Example: created-at
Sort on one or more fields using comma separated values.
filter: string (optional) Example: 1
Filter on one or more fields using comma separated values filter[field]=1,2.
page: string (optional) Example: 10
Use page[limit]=10 to reduce the number of instances returned. Use ?page[offset]=10 to skip this many instances.

Response 200

HideShow

Body

{
  "links": {
    "self": "/conferences/97iQjGNFLTZ5oxfYTKinwo/collaborators",
    "next": "/conferences/97iQjGNFLTZ5oxfYTKinwo/collaborators?page[offset]=10",
    "last": "/conferences/97iQjGNFLTZ5oxfYTKinwo/collaborators?page[offset]=100"
  },
  "meta": {
    "total": 1
  },
  "data": [
    {
      "id": "RaF56o2r58hTKT7AYS9doj",
      "type": "conferences-collaborators",
      "attributes": {
        "permission": "write",
        "is-archived": false,
        "created-at": "2020-01-01T00:00:00+00:00",
        "updated-at": "2020-01-01T00:00:00+00:00",
        "deleted-at": null
      },
      "relationships": {
        "membership": {
          "data": {
            "type": "memberships",
            "id": "6jVhCt5kE2p6e7B7SX9CGe"
          }
        },
        "team": {
          "data": null
        },
        "conference": {
          "data": {
            "type": "conferences",
            "id": "97iQjGNFLTZ5oxfYTKinwo"
          }
        },
        "created-by": {
          "data": {
            "type": "memberships",
            "id": "C7xWERND6yBTpJJVHACzVf"
          }
        },
        "updated-by": {
          "data": {
            "type": "memberships",
            "id": "C7xWERND6yBTpJJVHACzVf"
          }
        },
        "deleted-by": {
          "data": null
        }
      }
    }
  ]
}

Create Conference Collaborator
POST`/conferences/collaborators`

Create a new collaborator instance.

Example URI

POST https://api.omnigage.io/api/v1/conferences/collaborators

Request

HideShow

Body

{
  "data": {
    "type": "conferences-collaborators",
    "attributes": {
      "permission": "write"
    },
    "relationships": {
      "membership": {
        "data": {
          "type": "memberships",
          "id": "6jVhCt5kE2p6e7B7SX9CGe"
        }
      },
      "conference": {
        "data": {
          "type": "conferences",
          "id": "97iQjGNFLTZ5oxfYTKinwo"
        }
      }
    }
  }
}

Response 201

HideShow

Body

{
  "data": {
    "id": "RaF56o2r58hTKT7AYS9doj",
    "type": "conferences-collaborators",
    "attributes": {
      "permission": "write",
      "is-archived": false,
      "created-at": "2020-01-01T00:00:00+00:00",
      "updated-at": "2020-01-01T00:00:00+00:00",
      "deleted-at": null
    },
    "relationships": {
      "membership": {
        "data": {
          "type": "memberships",
          "id": "6jVhCt5kE2p6e7B7SX9CGe"
        }
      },
      "team": {
        "data": null
      },
      "conference": {
        "data": {
          "type": "conferences",
          "id": "97iQjGNFLTZ5oxfYTKinwo"
        }
      },
      "created-by": {
        "data": {
          "type": "memberships",
          "id": "C7xWERND6yBTpJJVHACzVf"
        }
      },
      "updated-by": {
        "data": {
          "type": "memberships",
          "id": "C7xWERND6yBTpJJVHACzVf"
        }
      },
      "deleted-by": {
        "data": null
      }
    }
  }
}

Conference Collaborator ¶

This resource manages updating and retrieving a specified collaborator instance.

Retrieve Conference Collaborator
GET`/conferences/collaborators/`

Retrieve an existing collaborator instance.

Example URI

GET https://api.omnigage.io/api/v1/conferences/collaborators/

Response 200

HideShow

Body

{
  "data": {
    "id": "RaF56o2r58hTKT7AYS9doj",
    "type": "conferences-collaborators",
    "attributes": {
      "permission": "write",
      "is-archived": false,
      "created-at": "2020-01-01T00:00:00+00:00",
      "updated-at": "2020-01-01T00:00:00+00:00",
      "deleted-at": null
    },
    "relationships": {
      "membership": {
        "data": {
          "type": "memberships",
          "id": "6jVhCt5kE2p6e7B7SX9CGe"
        }
      },
      "team": {
        "data": null
      },
      "conference": {
        "data": {
          "type": "conferences",
          "id": "97iQjGNFLTZ5oxfYTKinwo"
        }
      },
      "created-by": {
        "data": {
          "type": "memberships",
          "id": "C7xWERND6yBTpJJVHACzVf"
        }
      },
      "updated-by": {
        "data": {
          "type": "memberships",
          "id": "C7xWERND6yBTpJJVHACzVf"
        }
      },
      "deleted-by": {
        "data": null
      }
    }
  }
}

Update Conference Collaborator
PATCH`/conferences/collaborators/`

Update an existing collaborator instance.

Note: A membership cannot edit their own instance.

Example URI

PATCH https://api.omnigage.io/api/v1/conferences/collaborators/

Request

HideShow

Body

{
  "data": {
    "id": "RaF56o2r58hTKT7AYS9doj",
    "type": "conferences-collaborators",
    "attributes": {
      "permission": "write",
      "is-archived": false,
      "created-at": "2020-01-01T00:00:00+00:00",
      "updated-at": "2020-01-01T00:00:00+00:00",
      "deleted-at": null
    },
    "relationships": {
      "membership": {
        "data": {
          "type": "memberships",
          "id": "6jVhCt5kE2p6e7B7SX9CGe"
        }
      },
      "team": {
        "data": null
      },
      "conference": {
        "data": {
          "type": "conferences",
          "id": "97iQjGNFLTZ5oxfYTKinwo"
        }
      },
      "created-by": {
        "data": {
          "type": "memberships",
          "id": "C7xWERND6yBTpJJVHACzVf"
        }
      },
      "updated-by": {
        "data": {
          "type": "memberships",
          "id": "C7xWERND6yBTpJJVHACzVf"
        }
      },
      "deleted-by": {
        "data": null
      }
    }
  }
}

Response 202

HideShow

Body

{
  "data": {
    "id": "RaF56o2r58hTKT7AYS9doj",
    "type": "conferences-collaborators",
    "attributes": {
      "permission": "write",
      "is-archived": false,
      "created-at": "2020-01-01T00:00:00+00:00",
      "updated-at": "2020-01-01T00:00:00+00:00",
      "deleted-at": null
    },
    "relationships": {
      "membership": {
        "data": {
          "type": "memberships",
          "id": "6jVhCt5kE2p6e7B7SX9CGe"
        }
      },
      "team": {
        "data": null
      },
      "conference": {
        "data": {
          "type": "conferences",
          "id": "97iQjGNFLTZ5oxfYTKinwo"
        }
      },
      "created-by": {
        "data": {
          "type": "memberships",
          "id": "C7xWERND6yBTpJJVHACzVf"
        }
      },
      "updated-by": {
        "data": {
          "type": "memberships",
          "id": "C7xWERND6yBTpJJVHACzVf"
        }
      },
      "deleted-by": {
        "data": null
      }
    }
  }
}

Delete Conference Collaborator
DELETE`/conferences/collaborators/`

Sets the is-archived field’s value to true. Note: The actual instance is not deleted.

Note: A membership cannot delete their own instance.

Example URI

DELETE https://api.omnigage.io/api/v1/conferences/collaborators/

Response 204

Thread Resources ¶

Thread Collection ¶

This resource manages the retrieval of thread collections instances.

Threads are created and appended to based on the phone-number, caller-id or email-id instance’s collaborators. Thread instances are filtered based on collaborator access to the phone-number, caller-id or email-id relationships.

Retrieve Threads
GET`/threads{?q,include,filter,sort,page}`

Retrieve a collection of threads. Will include threads membership has created and has access to.

Example URI

GET https://api.omnigage.io/api/v1/threads?q=407&include=&filter=1&sort=created-at&page=10

URI Parameters

HideShow

q: string (optional) Example: 407
Search on thread label or a partial match on the from/to attributes.
include: string (optional)
Include one ore more related relationships using comma separated name.
sort: string (optional) Example: created-at
Sort on one or more fields using comma separated values.
filter: string (optional) Example: 1
Filter on one or more fields using comma separated values filter[field]=1,2.
page: string (optional) Example: 10
Use page[limit]=10 to reduce the number of instances returned. Use ?page[offset]=10 to skip this many instances.

Response 200

HideShow

Body

{
  "links": {
    "self": "/threads",
    "next": "/threads?page[offset]=10",
    "last": "/threads?page[offset]=100"
  },
  "meta": {
    "total": 110
  },
  "data": [
    {
      "id": "RaF56o2r58hTKT7AYS9doj",
      "type": "threads",
      "attributes": {
        "from": "+15197566220",
        "to": "+1519000101",
        "label": null,
        "appended-at": "2020-01-01T00:00:00+00:00",
        "appended-direct-at": null,
        "appended-inbound-at": "2020-01-01T00:00:00+00:00",
        "appended-outbound-at": null,
        "is-archived": false,
        "created-at": "2020-01-01T00:00:00+00:00",
        "updated-at": "2020-01-01T00:00:00+00:00"
      },
      "relationships": {
        "phone-number": {
          "data": {
            "type": "phone-numbers",
            "id": "kL68NjNxor5wbXRBLEbHsZ"
          }
        },
        "caller-id": {
          "data": {
            "type": "caller-ids",
            "id": "cTygUw3iyufdBNw6TDDPaH"
          }
        },
        "email-id": {
          "data": null
        },
        "contacts": {
          "links": {
            "related": "/threads/RaF56o2r58hTKT7AYS9doj/contacts"
          }
        },
        "updated-by": {
          "data": {
            "type": "memberships",
            "id": "C7xWERND6yBTpJJVHACzVf"
          }
        }
      }
    }
  ]
}

Thread ¶

This resource manages updating and retrieving a specified thread instance.

Retrieve Thread
GET`/threads/`

Retrieve an existing thread instance.

Example URI

GET https://api.omnigage.io/api/v1/threads/

Response 200

HideShow

Body

{
  "data": {
    "id": "RaF56o2r58hTKT7AYS9doj",
    "type": "threads",
    "attributes": {
      "from": "+15197566220",
      "to": "+1519000101",
      "label": null,
      "appended-at": "2020-01-01T00:00:00+00:00",
      "appended-direct-at": null,
      "appended-inbound-at": "2020-01-01T00:00:00+00:00",
      "appended-outbound-at": null,
      "is-archived": false,
      "created-at": "2020-01-01T00:00:00+00:00",
      "updated-at": "2020-01-01T00:00:00+00:00"
    },
    "relationships": {
      "phone-number": {
        "data": {
          "type": "phone-numbers",
          "id": "kL68NjNxor5wbXRBLEbHsZ"
        }
      },
      "caller-id": {
        "data": {
          "type": "caller-ids",
          "id": "cTygUw3iyufdBNw6TDDPaH"
        }
      },
      "email-id": {
        "data": null
      },
      "contacts": {
        "links": {
          "related": "/threads/RaF56o2r58hTKT7AYS9doj/contacts"
        }
      },
      "updated-by": {
        "data": {
          "type": "memberships",
          "id": "C7xWERND6yBTpJJVHACzVf"
        }
      }
    }
  }
}

Update Thread
PATCH`/threads/`

Update an existing thread instance.

Example URI

PATCH https://api.omnigage.io/api/v1/threads/

Request

HideShow

Body

{
  "data": {
    "id": "RaF56o2r58hTKT7AYS9doj",
    "type": "threads",
    "attributes": {
      "from": "+15197566220",
      "to": "+1519000101",
      "label": null,
      "appended-at": "2020-01-01T00:00:00+00:00",
      "appended-direct-at": null,
      "appended-inbound-at": "2020-01-01T00:00:00+00:00",
      "appended-outbound-at": null,
      "is-archived": false,
      "created-at": "2020-01-01T00:00:00+00:00",
      "updated-at": "2020-01-01T00:00:00+00:00"
    },
    "relationships": {
      "phone-number": {
        "data": {
          "type": "phone-numbers",
          "id": "kL68NjNxor5wbXRBLEbHsZ"
        }
      },
      "caller-id": {
        "data": {
          "type": "caller-ids",
          "id": "cTygUw3iyufdBNw6TDDPaH"
        }
      },
      "email-id": {
        "data": null
      },
      "contacts": {
        "links": {
          "related": "/threads/RaF56o2r58hTKT7AYS9doj/contacts"
        }
      },
      "updated-by": {
        "data": {
          "type": "memberships",
          "id": "C7xWERND6yBTpJJVHACzVf"
        }
      }
    }
  }
}

Response 202

HideShow

Body

{
  "data": {
    "id": "RaF56o2r58hTKT7AYS9doj",
    "type": "threads",
    "attributes": {
      "from": "+15197566220",
      "to": "+1519000101",
      "label": null,
      "appended-at": "2020-01-01T00:00:00+00:00",
      "appended-direct-at": null,
      "appended-inbound-at": "2020-01-01T00:00:00+00:00",
      "appended-outbound-at": null,
      "is-archived": false,
      "created-at": "2020-01-01T00:00:00+00:00",
      "updated-at": "2020-01-01T00:00:00+00:00"
    },
    "relationships": {
      "phone-number": {
        "data": {
          "type": "phone-numbers",
          "id": "kL68NjNxor5wbXRBLEbHsZ"
        }
      },
      "caller-id": {
        "data": {
          "type": "caller-ids",
          "id": "cTygUw3iyufdBNw6TDDPaH"
        }
      },
      "email-id": {
        "data": null
      },
      "contacts": {
        "links": {
          "related": "/threads/RaF56o2r58hTKT7AYS9doj/contacts"
        }
      },
      "updated-by": {
        "data": {
          "type": "memberships",
          "id": "C7xWERND6yBTpJJVHACzVf"
        }
      }
    }
  }
}

Delete
DELETE`/threads/`

Sets the is-archived field’s value to true. Note: The actual instance is not deleted.

Example URI

DELETE https://api.omnigage.io/api/v1/threads/

Response 204

Thread Item Collection ¶

This resource manages the retrieval of a given thread’s items and relationship creation.

Retrieve Thread Items
GET`/threads/items{?include,filter,sort,page}`

Retrieve a collection of thread items.

Example URI

GET https://api.omnigage.io/api/v1/threads/items?include=&filter=1&sort=created-at&page=10

URI Parameters

HideShow

include: string (optional)
Include one ore more related relationships using comma separated name.
sort: string (optional) Example: created-at
Sort on one or more fields using comma separated values.
filter: string (optional) Example: 1
Filter on one or more fields using comma separated values filter[field]=1,2.
page: string (optional) Example: 10
Use page[limit]=10 to reduce the number of instances returned. Use ?page[offset]=10 to skip this many instances.

Response 200

HideShow

Body

{
  "links": {
    "self": "/threads/vytxeTZskVKR7C7WgdSP3d/items",
    "next": "/threads/vytxeTZskVKR7C7WgdSP3d/items?page[offset]=10",
    "last": "/threads/vytxeTZskVKR7C7WgdSP3d/items?page[offset]=100"
  },
  "meta": {
    "total": 110
  },
  "data": [
    {
      "id": "RaF56o2r58hTKT7AYS9doj",
      "type": "threads-items",
      "attributes": {
        "created-at": "2020-01-01T00:00:00+00:00",
        "updated-at": "2020-01-01T00:00:00+00:00"
      },
      "relationships": {
        "thread": {
          "data": {
            "type": "threads",
            "id": "vytxeTZskVKR7C7WgdSP3d"
          }
        },
        "phone-number": {
          "data": {
            "type": "phone-numbers",
            "id": "96Fxm56e75RFQpnCbNtnF7"
          }
        },
        "caller-id": {
          "data": {
            "type": "caller-ids",
            "id": "cTygUw3iyufdBNw6TDDPaH"
          }
        },
        "email-id": {
          "data": null
        },
        "call": {
          "data": {
            "type": "calls",
            "id": "LzGK5r8JfSQKCvXWCnCemP"
          }
        },
        "text": {
          "data": null
        },
        "email": {
          "data": null
        },
        "updated-by": {
          "data": {
            "type": "memberships",
            "id": "C7xWERND6yBTpJJVHACzVf"
          }
        }
      }
    }
  ]
}

Thread Item ¶

This resource manages retrieving a specified thread item instance.

Retrieve Thread Item
GET`/threads/items/`

Retrieve an existing thread item instance.

Example URI

GET https://api.omnigage.io/api/v1/threads/items/

Response 200

HideShow

Body

{
  "data": {
    "id": "RaF56o2r58hTKT7AYS9doj",
    "type": "threads-items",
    "attributes": {
      "created-at": "2020-01-01T00:00:00+00:00",
      "updated-at": "2020-01-01T00:00:00+00:00"
    },
    "relationships": {
      "thread": {
        "data": {
          "type": "threads",
          "id": "vytxeTZskVKR7C7WgdSP3d"
        }
      },
      "phone-number": {
        "data": {
          "type": "phone-numbers",
          "id": "96Fxm56e75RFQpnCbNtnF7"
        }
      },
      "caller-id": {
        "data": null
      },
      "email-id": {
        "data": null
      },
      "call": {
        "data": {
          "type": "calls",
          "id": "LzGK5r8JfSQKCvXWCnCemP"
        }
      },
      "text": {
        "data": null
      },
      "email": {
        "data": null
      },
      "updated-by": {
        "data": {
          "type": "memberships",
          "id": "C7xWERND6yBTpJJVHACzVf"
        }
      }
    }
  }
}

Thread Contact Collection ¶

This resource manages the retrieval of thread contact collections and the creation of thread contact instances.

Retrieve Thread Contacts
GET`/threads/contacts{?include,sort,filter,page}`

Retrieve a collection of contacts.

Example URI

GET https://api.omnigage.io/api/v1/threads/contacts?include=&sort=created-at&filter=1&page=10

URI Parameters

HideShow

include: string (optional)
Include one ore more related relationships using comma separated name.
sort: string (optional) Example: created-at
Sort on one or more fields using comma separated values.
filter: string (optional) Example: 1
Filter on one or more fields using comma separated values filter[field]=1,2.
page: string (optional) Example: 10
Use page[limit]=10 to reduce the number of instances returned. Use ?page[offset]=10 to skip this many instances.

Response 200

HideShow

Body

{
  "links": {
    "self": "/threads/97iQjGNFLTZ5oxfYTKinwo/contacts",
    "next": "/threads/97iQjGNFLTZ5oxfYTKinwo/contacts?page[offset]=10",
    "last": "/threads/97iQjGNFLTZ5oxfYTKinwo/contacts?page[offset]=100"
  },
  "meta": {
    "total": 1
  },
  "data": [
    {
      "id": "RaF56o2r58hTKT7AYS9doj",
      "type": "threads-contacts",
      "attributes": {
        "created-at": "2020-01-01T00:00:00+00:00",
        "updated-at": "2020-01-01T00:00:00+00:00"
      },
      "relationships": {
        "contact": {
          "data": {
            "type": "contacts",
            "id": "6jVhCt5kE2p6e7B7SX9CGe"
          }
        },
        "thread": {
          "data": {
            "type": "threads",
            "id": "97iQjGNFLTZ5oxfYTKinwo"
          }
        },
        "created-by": {
          "data": {
            "type": "memberships",
            "id": "C7xWERND6yBTpJJVHACzVf"
          }
        },
        "updated-by": {
          "data": {
            "type": "memberships",
            "id": "C7xWERND6yBTpJJVHACzVf"
          }
        }
      }
    }
  ]
}

Create Thread Contact
POST`/threads/contacts`

Create a new thread contact instance.

Note: Must have collaborator access to both related thread and contact.

Example URI

POST https://api.omnigage.io/api/v1/threads/contacts

Request

HideShow

Body

{
  "data": {
    "type": "threads-contacts",
    "relationships": {
      "contact": {
        "data": {
          "type": "contact",
          "id": "6jVhCt5kE2p6e7B7SX9CGe"
        }
      },
      "thread": {
        "data": {
          "type": "threads",
          "id": "97iQjGNFLTZ5oxfYTKinwo"
        }
      }
    }
  }
}

Response 201

HideShow

Body

{
  "data": {
    "id": "RaF56o2r58hTKT7AYS9doj",
    "type": "threads-contacts",
    "attributes": {
      "created-at": "2020-01-01T00:00:00+00:00",
      "updated-at": "2020-01-01T00:00:00+00:00"
    },
    "relationships": {
      "contact": {
        "data": {
          "type": "contacts",
          "id": "6jVhCt5kE2p6e7B7SX9CGe"
        }
      },
      "thread": {
        "data": {
          "type": "threads",
          "id": "97iQjGNFLTZ5oxfYTKinwo"
        }
      },
      "created-by": {
        "data": {
          "type": "memberships",
          "id": "C7xWERND6yBTpJJVHACzVf"
        }
      },
      "updated-by": {
        "data": {
          "type": "memberships",
          "id": "C7xWERND6yBTpJJVHACzVf"
        }
      }
    }
  }
}

Thread Contact ¶

This resource manages retrieving and deleting a specified contact instance.

Retrieve Thread Contact
GET`/threads/contacts/`

Retrieve an existing contact instance.

Example URI

GET https://api.omnigage.io/api/v1/threads/contacts/

Response 200

HideShow

Body

{
  "data": {
    "id": "RaF56o2r58hTKT7AYS9doj",
    "type": "threads-contacts",
    "attributes": {
      "created-at": "2020-01-01T00:00:00+00:00",
      "updated-at": "2020-01-01T00:00:00+00:00"
    },
    "relationships": {
      "contact": {
        "data": {
          "type": "contacts",
          "id": "6jVhCt5kE2p6e7B7SX9CGe"
        }
      },
      "thread": {
        "data": {
          "type": "threads",
          "id": "97iQjGNFLTZ5oxfYTKinwo"
        }
      },
      "created-by": {
        "data": {
          "type": "memberships",
          "id": "C7xWERND6yBTpJJVHACzVf"
        }
      },
      "updated-by": {
        "data": {
          "type": "memberships",
          "id": "C7xWERND6yBTpJJVHACzVf"
        }
      }
    }
  }
}

Delete Thread Contact
DELETE`/threads/contacts/`

Note: Must have collaborator access to both related thread and contact.

Example URI

DELETE https://api.omnigage.io/api/v1/threads/contacts/

Response 204

Thread Read Collection ¶

This resource manages the retrieval and the creation of thread read instances.

Retrieve Thread Reads
GET`/thread-reads{?include,sort,filter,page}`

Retrieve a collection of reads.

Example URI

GET https://api.omnigage.io/api/v1/thread-reads?include=&sort=created-at&filter=1&page=10

URI Parameters

HideShow

include: string (optional)
Include one ore more related relationships using comma separated name.
sort: string (optional) Example: created-at
Sort on one or more fields using comma separated values.
filter: string (optional) Example: 1
Filter on one or more fields using comma separated values filter[field]=1,2.
page: string (optional) Example: 10
Use page[limit]=10 to reduce the number of instances returned. Use ?page[offset]=10 to skip this many instances.

Response 200

HideShow

Body

{
  "links": {
    "self": "/thread-reads",
    "next": "/thread-reads?page[offset]=10",
    "last": "/thread-reads?page[offset]=100"
  },
  "meta": {
    "total": 1
  },
  "data": [
    {
      "id": "RaF56o2r58hTKT7AYS9doj",
      "type": "thread-reads",
      "attributes": {
        "created-at": "2020-01-01T00:00:00+00:00",
        "updated-at": "2020-01-01T00:00:00+00:00"
      },
      "relationships": {
        "thread": {
          "data": {
            "type": "threads",
            "id": "97iQjGNFLTZ5oxfYTKinwo"
          }
        },
        "created-by": {
          "data": {
            "type": "memberships",
            "id": "C7xWERND6yBTpJJVHACzVf"
          }
        },
        "updated-by": {
          "data": {
            "type": "memberships",
            "id": "C7xWERND6yBTpJJVHACzVf"
          }
        }
      }
    }
  ]
}

Create Thread Read
POST`/thread-reads`

Create a new thread read instance.

Note: Must have collaborator access to related thread. If a thread read instance already exists for the membership, the updated-at attribute will be updated and the instance returned.

Example URI

POST https://api.omnigage.io/api/v1/thread-reads

Request

HideShow

Body

{
  "data": {
    "type": "thread-reads",
    "relationships": {
      "thread": {
        "data": {
          "type": "threads",
          "id": "97iQjGNFLTZ5oxfYTKinwo"
        }
      }
    }
  }
}

Response 201

HideShow

Body

{
  "data": {
    "id": "RaF56o2r58hTKT7AYS9doj",
    "type": "thread-reads",
    "attributes": {
      "created-at": "2020-01-01T00:00:00+00:00",
      "updated-at": "2020-01-01T00:00:00+00:00"
    },
    "relationships": {
      "thread": {
        "data": {
          "type": "threads",
          "id": "97iQjGNFLTZ5oxfYTKinwo"
        }
      },
      "created-by": {
        "data": {
          "type": "memberships",
          "id": "C7xWERND6yBTpJJVHACzVf"
        }
      },
      "updated-by": {
        "data": {
          "type": "memberships",
          "id": "C7xWERND6yBTpJJVHACzVf"
        }
      }
    }
  }
}

Thread Read ¶

This resource manages retrieving a read instance.

Retrieve Thread Read
GET`/thread-reads/`

Retrieve an existing read instance.

Example URI

GET https://api.omnigage.io/api/v1/thread-reads/

Response 200

HideShow

Body

{
  "data": {
    "id": "RaF56o2r58hTKT7AYS9doj",
    "type": "thread-reads",
    "attributes": {
      "created-at": "2020-01-01T00:00:00+00:00",
      "updated-at": "2020-01-01T00:00:00+00:00"
    },
    "relationships": {
      "thread": {
        "data": {
          "type": "threads",
          "id": "97iQjGNFLTZ5oxfYTKinwo"
        }
      },
      "created-by": {
        "data": {
          "type": "memberships",
          "id": "C7xWERND6yBTpJJVHACzVf"
        }
      },
      "updated-by": {
        "data": {
          "type": "memberships",
          "id": "C7xWERND6yBTpJJVHACzVf"
        }
      }
    }
  }
}

Integration Resources ¶

CIA CallTracker Collection ¶

This resource provides querying of the CIA CallTrackers collection along with the creation of CIA CallTracker instances.

CIA CallTrackers work as follows:

Omnigage receives an event from CIA CallTracker when a call originates. The event is sent to the endpoint provided when creating an Omnigage cia-calltrackers instance.
The event includes a unique extension. This extension is then mapped to a phone number defined on /cia-calltrackers/{cia_calltracker_id}/phone-numbers.
The phone number and extension combination is then used to look up a valid caller-ids instance.
If a valid caller-id instance is identified, an Omnigage calls instance is created and the collaborators of the caller-id are notified of the inbound call.
The collaborators of the caller-id can then answer or decline by updating the calls instance.

Note: This resource is only accessible by account admins.

Retrieve CIA CallTracker
GET`/cia-calltrackers{?include,filter,sort,page}`

Retrieve a collection of CIA CallTrackers.

Example URI

GET https://api.omnigage.io/api/v1/cia-calltrackers?include=&filter=1&sort=created-at&page=10

URI Parameters

HideShow

include: string (optional)
Include one ore more related relationships using comma separated name.
sort: string (optional) Example: created-at
Sort on one or more fields using comma separated values.
filter: string (optional) Example: 1
Filter on one or more fields using comma separated values filter[field]=1,2.
page: string (optional) Example: 10
Use page[limit]=10 to reduce the number of instances returned. Use ?page[offset]=10 to skip this many instances.

Response 200

HideShow

Body

{
  "links": {
    "self": "/cia-calltrackers",
    "next": "/cia-calltrackers?page[offset]=10",
    "last": "/cia-calltrackers?page[offset]=100"
  },
  "meta": {
    "total": 10
  },
  "data": [
    {
      "id": "BWKWskkJfcJpoViFgPcB2Z",
      "type": "cia-calltrackers",
      "attributes": {
        "label": "Headquarters",
        "username": "*******YUHoL",
        "password": null,
        "endpoint": "https://api.omnigage.io/account/v1/inbound/cia-calltrackers/BWKWskkJfcJpoViFgPcB2Z/UmsTuTbvkPpFnUJwXNYha8/",
        "count-phone-numbers": 1,
        "created-at": "2020-01-01T00:00:00+00:00",
        "updated-at": "2020-01-01T00:00:00+00:00"
      },
      "relationships": {
        "phone-numbers": {
          "links": {
            "related": "/cia-calltrackers/BWKWskkJfcJpoViFgPcB2Z/phone-numbers"
          }
        },
        "created-by": {
          "data": {
            "type": "memberships",
            "id": "C7xWERND6yBTpJJVHACzVf"
          }
        },
        "updated-by": {
          "data": {
            "type": "memberships",
            "id": "C7xWERND6yBTpJJVHACzVf"
          }
        }
      }
    }
  ]
}

Create CIA CallTracker
POST`/cia-calltrackers`

Create a new CIA CallTrackers instance.

Example URI

POST https://api.omnigage.io/api/v1/cia-calltrackers

Request

HideShow

Body

{
  "data": {
    "type": "cia-calltrackers",
    "attributes": {
      "label": "Headquarters",
      "username": "gxzCtRGDxTkZJYUHoL",
      "password": "wzBVtyAOLtNi7yCtAQLrpt"
    }
  }
}

Response 201

HideShow

Body

{
  "data": {
    "id": "BWKWskkJfcJpoViFgPcB2Z",
    "type": "cia-calltrackers",
    "attributes": {
      "label": "Headquarters",
      "username": "*******YUHoL",
      "password": null,
      "endpoint": "https://api.omnigage.io/account/v1/inbound/cia-calltrackers/BWKWskkJfcJpoViFgPcB2Z/UmsTuTbvkPpFnUJwXNYha8/",
      "count-phone-numbers": 1,
      "created-at": "2020-01-01T00:00:00+00:00",
      "updated-at": "2020-01-01T00:00:00+00:00"
    },
    "relationships": {
      "phone-numbers": {
        "links": {
          "related": "/cia-calltrackers/BWKWskkJfcJpoViFgPcB2Z/phone-numbers"
        }
      },
      "created-by": {
        "data": {
          "type": "memberships",
          "id": "C7xWERND6yBTpJJVHACzVf"
        }
      },
      "updated-by": {
        "data": {
          "type": "memberships",
          "id": "C7xWERND6yBTpJJVHACzVf"
        }
      }
    }
  }
}

CIA CallTracker ¶

This resource manages updating, removing, and retrieving a specified CIA CallTracker instance.

Note: This resource is only accessible by account admins.

Retrieve CIA CallTracker
GET`/cia-calltrackers/`

Retrieve an existing CIA CallTrackers instance.

Example URI

GET https://api.omnigage.io/api/v1/cia-calltrackers/

Response 200

HideShow

Body

{
  "data": {
    "id": "BWKWskkJfcJpoViFgPcB2Z",
    "type": "cia-calltrackers",
    "attributes": {
      "label": "Headquarters",
      "username": "*******YUHoL",
      "password": null,
      "endpoint": "https://api.omnigage.io/account/v1/inbound/cia-calltrackers/BWKWskkJfcJpoViFgPcB2Z/UmsTuTbvkPpFnUJwXNYha8/",
      "count-phone-numbers": 1,
      "created-at": "2020-01-01T00:00:00+00:00",
      "updated-at": "2020-01-01T00:00:00+00:00"
    },
    "relationships": {
      "phone-numbers": {
        "links": {
          "related": "/cia-calltrackers/BWKWskkJfcJpoViFgPcB2Z/phone-numbers"
        }
      },
      "created-by": {
        "data": {
          "type": "memberships",
          "id": "C7xWERND6yBTpJJVHACzVf"
        }
      },
      "updated-by": {
        "data": {
          "type": "memberships",
          "id": "C7xWERND6yBTpJJVHACzVf"
        }
      }
    }
  }
}

Update CIA CallTracker
PATCH`/cia-calltrackers/`

Update an existing CIA CallTrackers instance.

Example URI

PATCH https://api.omnigage.io/api/v1/cia-calltrackers/

Request

HideShow

Body

{
  "data": {
    "id": "BWKWskkJfcJpoViFgPcB2Z",
    "type": "cia-calltrackers",
    "attributes": {
      "label": "Headquarters",
      "username": "GcHC4pSqW77z9m9FRJY9UO",
      "password": "nkkqt0jsWlzADOH8UISCc9"
    }
  }
}

Response 202

HideShow

Body

{
  "data": {
    "id": "BWKWskkJfcJpoViFgPcB2Z",
    "type": "cia-calltrackers",
    "attributes": {
      "label": "Headquarters",
      "username": "*******YUHoL",
      "password": null,
      "endpoint": "https://api.omnigage.io/account/v1/inbound/cia-calltrackers/BWKWskkJfcJpoViFgPcB2Z/UmsTuTbvkPpFnUJwXNYha8/",
      "count-phone-numbers": 1,
      "created-at": "2020-01-01T00:00:00+00:00",
      "updated-at": "2020-01-01T00:00:00+00:00"
    },
    "relationships": {
      "phone-numbers": {
        "links": {
          "related": "/cia-calltrackers/BWKWskkJfcJpoViFgPcB2Z/phone-numbers"
        }
      },
      "created-by": {
        "data": {
          "type": "memberships",
          "id": "C7xWERND6yBTpJJVHACzVf"
        }
      },
      "updated-by": {
        "data": {
          "type": "memberships",
          "id": "C7xWERND6yBTpJJVHACzVf"
        }
      }
    }
  }
}

Delete CIA CallTracker
DELETE`/cia-calltrackers/`

Delete an existing CIA CallTrackers instance.

Example URI

DELETE https://api.omnigage.io/api/v1/cia-calltrackers/

Response 204

CIA CallTracker Phone Number Collection ¶

This resource provides querying of the CIA CallTracker phone numbers collection along with the creation of instances.

Note: This resource is only accessible by account admins.

Retrieve CIA CallTracker Phone Numbers
GET`/cia-calltrackers/phone-numbers{?include,filter,sort,page}`

Retrieve a collection of CIA CallTrackers.

Example URI

GET https://api.omnigage.io/api/v1/cia-calltrackers/phone-numbers?include=&filter=1&sort=created-at&page=10

URI Parameters

HideShow

include: string (optional)
Include one ore more related relationships using comma separated name.
sort: string (optional) Example: created-at
Sort on one or more fields using comma separated values.
filter: string (optional) Example: 1
Filter on one or more fields using comma separated values filter[field]=1,2.
page: string (optional) Example: 10
Use page[limit]=10 to reduce the number of instances returned. Use ?page[offset]=10 to skip this many instances.

Response 200

HideShow

Body

{
  "links": {
    "self": "/cia-calltrackers/BWKWskkJfcJpoViFgPcB2Z/phone-numbers",
    "next": "/cia-calltrackers/BWKWskkJfcJpoViFgPcB2Z/phone-numbers?page[offset]=10",
    "last": "/cia-calltrackers/BWKWskkJfcJpoViFgPcB2Z/phone-numbers?page[offset]=100"
  },
  "meta": {
    "total": 10
  },
  "data": [
    {
      "id": "BWKWskkJfcJpoViFgPcB2Z",
      "type": "cia-calltrackers-phone-numbers",
      "attributes": {
        "phone-number": "+15197566220",
        "created-at": "2020-01-01T00:00:00+00:00",
        "updated-at": "2020-01-01T00:00:00+00:00"
      },
      "relationships": {
        "cia-calltracker": {
          "data": {
            "type": "cia-calltrackers",
            "id": "K8BETeaVbQXAjW8aWKT2Cx"
          }
        },
        "created-by": {
          "data": {
            "type": "memberships",
            "id": "C7xWERND6yBTpJJVHACzVf"
          }
        },
        "updated-by": {
          "data": {
            "type": "memberships",
            "id": "C7xWERND6yBTpJJVHACzVf"
          }
        }
      }
    }
  ]
}

Create CIA CallTracker Phone Number
POST`/cia-calltrackers/phone-numbers`

Create a new CIA CallTracker phone number instance.

Example URI

POST https://api.omnigage.io/api/v1/cia-calltrackers/phone-numbers

Request

HideShow

Body

{
  "data": {
    "type": "cia-calltrackers-phone-numbers",
    "attributes": {
      "phone-number": "+15197566220"
    },
    "relationships": {
      "cia-calltracker": {
        "data": {
          "type": "cia-calltrackers",
          "id": "K8BETeaVbQXAjW8aWKT2Cx"
        }
      }
    }
  }
}

Response 201

HideShow

Body

{
  "data": {
    "id": "BWKWskkJfcJpoViFgPcB2Z",
    "type": "cia-calltrackers-phone-numbers",
    "attributes": {
      "phone-number": "+15197566220",
      "created-at": "2020-01-01T00:00:00+00:00",
      "updated-at": "2020-01-01T00:00:00+00:00"
    },
    "relationships": {
      "cia-calltracker": {
        "data": {
          "type": "cia-calltrackers",
          "id": "K8BETeaVbQXAjW8aWKT2Cx"
        }
      },
      "created-by": {
        "data": {
          "type": "memberships",
          "id": "C7xWERND6yBTpJJVHACzVf"
        }
      },
      "updated-by": {
        "data": {
          "type": "memberships",
          "id": "C7xWERND6yBTpJJVHACzVf"
        }
      }
    }
  }
}

CIA CallTracker Phone Number ¶

This resource manages updating, removing, and retrieving a specified CIA CallTracker phone number instance.

Note: This resource is only accessible by account admins.

Retrieve CIA CallTracker Phone Number
GET`/cia-calltrackers/phone-numbers/`

Retrieve an existing CIA CallTrackers phone number instance.

Example URI

GET https://api.omnigage.io/api/v1/cia-calltrackers/phone-numbers/

Response 200

HideShow

Body

{
  "data": {
    "id": "BWKWskkJfcJpoViFgPcB2Z",
    "type": "cia-calltrackers-phone-numbers",
    "attributes": {
      "phone-number": "+15197566220",
      "created-at": "2020-01-01T00:00:00+00:00",
      "updated-at": "2020-01-01T00:00:00+00:00"
    },
    "relationships": {
      "cia-calltracker": {
        "data": {
          "type": "cia-calltrackers",
          "id": "K8BETeaVbQXAjW8aWKT2Cx"
        }
      },
      "created-by": {
        "data": {
          "type": "memberships",
          "id": "C7xWERND6yBTpJJVHACzVf"
        }
      },
      "updated-by": {
        "data": {
          "type": "memberships",
          "id": "C7xWERND6yBTpJJVHACzVf"
        }
      }
    }
  }
}

Update CIA CallTracker Phone Number
PATCH`/cia-calltrackers/phone-numbers/`

Update an existing CIA CallTrackers phone number instance.

Example URI

PATCH https://api.omnigage.io/api/v1/cia-calltrackers/phone-numbers/

Request

HideShow

Body

{
  "data": {
    "id": "BWKWskkJfcJpoViFgPcB2Z",
    "type": "cia-calltrackers-phone-numbers",
    "attributes": {
      "phone-number": "+15197566220"
    },
    "relationships": {
      "cia-calltracker": {
        "data": {
          "type": "cia-calltrackers",
          "id": "K8BETeaVbQXAjW8aWKT2Cx"
        }
      }
    }
  }
}

Response 202

HideShow

Body

{
  "data": {
    "id": "BWKWskkJfcJpoViFgPcB2Z",
    "type": "cia-calltrackers-phone-numbers",
    "attributes": {
      "phone-number": "+15197566220",
      "created-at": "2020-01-01T00:00:00+00:00",
      "updated-at": "2020-01-01T00:00:00+00:00"
    },
    "relationships": {
      "cia-calltracker": {
        "data": {
          "type": "cia-calltrackers",
          "id": "K8BETeaVbQXAjW8aWKT2Cx"
        }
      },
      "created-by": {
        "data": {
          "type": "memberships",
          "id": "C7xWERND6yBTpJJVHACzVf"
        }
      },
      "updated-by": {
        "data": {
          "type": "memberships",
          "id": "C7xWERND6yBTpJJVHACzVf"
        }
      }
    }
  }
}

Delete CIA CallTracker Phone Number
DELETE`/cia-calltrackers/phone-numbers/`

Delete an existing CIA CallTrackers phone number instance.

Example URI

DELETE https://api.omnigage.io/api/v1/cia-calltrackers/phone-numbers/

Response 204

Pages Resources ¶

Page Collection ¶

This resource manages the retrieval of page collections and the creation of page instances.

Retrieve Pages
GET`/pages{?include,filter,sort,page}`

Retrieve a collection of pages.

Example URI

GET https://api.omnigage.io/api/v1/pages?include=&filter=1&sort=created-at&page=10

URI Parameters

HideShow

include: string (optional)
Include one ore more related relationships using comma separated name.
sort: string (optional) Example: created-at
Sort on one or more fields using comma separated values.
filter: string (optional) Example: 1
Filter on one or more fields using comma separated values filter[field]=1,2.
page: string (optional) Example: 10
Use page[limit]=10 to reduce the number of instances returned. Use ?page[offset]=10 to skip this many instances.

Response 200

HideShow

Body

{
  "links": {
    "self": "/pages",
    "next": "/pages?page[offset]=10",
    "last": "/pages?page[offset]=100"
  },
  "meta": {
    "total": 110
  },
  "data": [
    {
      "id": "RaF56o2r58hTKT7AYS9doj",
      "type": "pages",
      "attributes": {
        "name": "Technology Sector News",
        "key": "tech-sector",
        "url": "https://www.omnigage.io/tech-sector",
        "description": "Most recent news on the technology sector.",
        "visibility": "public",
        "status": "pending",
        "count-subscribers": 28335,
        "count-posts": 157,
        "is-active": true,
        "is-archived": false,
        "created-at": "2020-01-01T00:00:00+00:00",
        "updated-at": "2020-01-01T00:00:00+00:00",
        "deleted-at": null
      },
      "relationships": {
        "primary": {
          "data": {
            "type": "pages",
            "id": "RaF56o2r58hTKT7AYS9doj"
          }
        },
        "published": {
          "data": {
            "type": "pages",
            "id": "KR7C7WgdvytxeTSP3dZskV"
          }
        },
        "revision": {
          "data": {
            "type": "pages",
            "id": "KR7C7WgdvytxeTSP3dZskV"
          }
        },
        "revisions": {
          "links": {
            "related": "/pages/RaF56o2r58hTKT7AYS9doj/revisions"
          }
        },
        "subscriptions": {
          "links": {
            "related": "/subscriptions?filter[page.id]=RaF56o2r58hTKT7AYS9doj"
          }
        },
        "reviews": {
          "links": {
            "related": "/reviews?filter[page.id]=RaF56o2r58hTKT7AYS9doj"
          }
        },
        "image": {
          "data": {
            "type": "files",
            "id": "iwx7c9SwZp6yPRZfqheQUL"
          }
        },
        "created-by": {
          "data": {
            "type": "memberships",
            "id": "C7xWERND6yBTpJJVHACzVf"
          }
        },
        "updated-by": {
          "data": {
            "type": "memberships",
            "id": "C7xWERND6yBTpJJVHACzVf"
          }
        },
        "deleted-by": {
          "data": null
        }
      }
    }
  ]
}

Create Page
POST`/pages`

Create a new page instance.

Example URI

POST https://api.omnigage.io/api/v1/pages

Request

HideShow

Body

{
  "data": {
    "id": "RaF56o2r58hTKT7AYS9doj",
    "type": "pages",
    "attributes": {
      "name": "Technology Sector News",
      "key": "tech-sector",
      "description": "Most recent news on the technology sector.",
      "visibility": "public",
      "is-active": true
    },
    "relationships": {
      "upload": {
        "data": {
          "type": "uploads",
          "id": "86sfmHEwxYuthNBLYCq2Sz"
        }
      }
    }
  }
}

Response 201

HideShow

Body

{
  "data": {
    "id": "RaF56o2r58hTKT7AYS9doj",
    "type": "pages",
    "attributes": {
      "name": "Technology Sector News",
      "key": "tech-sector",
      "url": "https://www.omnigage.io/tech-sector",
      "description": "Most recent news on the technology sector.",
      "visibility": "public",
      "status": "pending",
      "count-subscribers": 28335,
      "count-posts": 157,
      "is-active": true,
      "is-archived": false,
      "created-at": "2020-01-01T00:00:00+00:00",
      "updated-at": "2020-01-01T00:00:00+00:00",
      "deleted-at": null
    },
    "relationships": {
      "primary": {
        "data": {
          "type": "pages",
          "id": "RaF56o2r58hTKT7AYS9doj"
        }
      },
      "published": {
        "data": {
          "type": "pages",
          "id": "KR7C7WgdvytxeTSP3dZskV"
        }
      },
      "revision": {
        "data": {
          "type": "pages",
          "id": "KR7C7WgdvytxeTSP3dZskV"
        }
      },
      "revisions": {
        "links": {
          "related": "/pages/RaF56o2r58hTKT7AYS9doj/revisions"
        }
      },
      "subscriptions": {
        "links": {
          "related": "/subscriptions?filter[page.id]=RaF56o2r58hTKT7AYS9doj"
        }
      },
      "reviews": {
        "links": {
          "related": "/reviews?filter[page.id]=RaF56o2r58hTKT7AYS9doj"
        }
      },
      "image": {
        "data": {
          "type": "files",
          "id": "iwx7c9SwZp6yPRZfqheQUL"
        }
      },
      "created-by": {
        "data": {
          "type": "memberships",
          "id": "C7xWERND6yBTpJJVHACzVf"
        }
      },
      "updated-by": {
        "data": {
          "type": "memberships",
          "id": "C7xWERND6yBTpJJVHACzVf"
        }
      },
      "deleted-by": {
        "data": null
      }
    }
  }
}

Page ¶

This resource manages updating and retrieving a specified page instance.

Retrieve Page
GET`/pages/`

Retrieve an existing page instance.

Example URI

GET https://api.omnigage.io/api/v1/pages/

Response 200

HideShow

Body

{
  "data": {
    "id": "RaF56o2r58hTKT7AYS9doj",
    "type": "pages",
    "attributes": {
      "name": "Technology Sector News",
      "key": "tech-sector",
      "url": "https://www.omnigage.io/tech-sector",
      "description": "Most recent news on the technology sector.",
      "visibility": "public",
      "status": "pending",
      "count-subscribers": 28335,
      "count-posts": 157,
      "is-active": true,
      "is-archived": false,
      "created-at": "2020-01-01T00:00:00+00:00",
      "updated-at": "2020-01-01T00:00:00+00:00",
      "deleted-at": null
    },
    "relationships": {
      "primary": {
        "data": {
          "type": "pages",
          "id": "RaF56o2r58hTKT7AYS9doj"
        }
      },
      "published": {
        "data": {
          "type": "pages",
          "id": "KR7C7WgdvytxeTSP3dZskV"
        }
      },
      "revision": {
        "data": {
          "type": "pages",
          "id": "KR7C7WgdvytxeTSP3dZskV"
        }
      },
      "revisions": {
        "links": {
          "related": "/pages/RaF56o2r58hTKT7AYS9doj/revisions"
        }
      },
      "subscriptions": {
        "links": {
          "related": "/subscriptions?filter[page.id]=RaF56o2r58hTKT7AYS9doj"
        }
      },
      "reviews": {
        "links": {
          "related": "/reviews?filter[page.id]=RaF56o2r58hTKT7AYS9doj"
        }
      },
      "image": {
        "data": {
          "type": "files",
          "id": "iwx7c9SwZp6yPRZfqheQUL"
        }
      },
      "created-by": {
        "data": {
          "type": "memberships",
          "id": "C7xWERND6yBTpJJVHACzVf"
        }
      },
      "updated-by": {
        "data": {
          "type": "memberships",
          "id": "C7xWERND6yBTpJJVHACzVf"
        }
      },
      "deleted-by": {
        "data": null
      }
    }
  }
}

Update Page
PATCH`/pages/`

Update an existing page instance.

Below is the life cycle of revisions:

Updating will create a new revision. This includes adding or archiving files.
The published relationship is the syndicated revision.
When a new revision is created, the previous published revision remains set.
To publish a new revision, perform an update setting the revision id as the published relationship or set the status to published.
If pre-compliance is enabled, the revision must be approved.
New revisions default to a status of pending. To publish a new revision, the status must be review-approved.

Example URI

PATCH https://api.omnigage.io/api/v1/pages/

Request

HideShow

Body

{
  "data": {
    "id": "RaF56o2r58hTKT7AYS9doj",
    "type": "pages",
    "attributes": {
      "name": "Technology Sector News",
      "key": "tech-sector",
      "url": "https://www.omnigage.io/tech-sector",
      "description": "Most recent news on the technology sector.",
      "visibility": "public",
      "status": "pending",
      "count-subscribers": 28335,
      "count-posts": 157,
      "is-active": true,
      "is-archived": false,
      "created-at": "2020-01-01T00:00:00+00:00",
      "updated-at": "2020-01-01T00:00:00+00:00",
      "deleted-at": null
    },
    "relationships": {
      "primary": {
        "data": {
          "type": "pages",
          "id": "RaF56o2r58hTKT7AYS9doj"
        }
      },
      "published": {
        "data": {
          "type": "pages",
          "id": "KR7C7WgdvytxeTSP3dZskV"
        }
      },
      "revision": {
        "data": {
          "type": "pages",
          "id": "KR7C7WgdvytxeTSP3dZskV"
        }
      },
      "revisions": {
        "links": {
          "related": "/pages/RaF56o2r58hTKT7AYS9doj/revisions"
        }
      },
      "subscriptions": {
        "links": {
          "related": "/subscriptions?filter[page.id]=RaF56o2r58hTKT7AYS9doj"
        }
      },
      "reviews": {
        "links": {
          "related": "/reviews?filter[page.id]=RaF56o2r58hTKT7AYS9doj"
        }
      },
      "image": {
        "data": {
          "type": "files",
          "id": "iwx7c9SwZp6yPRZfqheQUL"
        }
      },
      "created-by": {
        "data": {
          "type": "memberships",
          "id": "C7xWERND6yBTpJJVHACzVf"
        }
      },
      "updated-by": {
        "data": {
          "type": "memberships",
          "id": "C7xWERND6yBTpJJVHACzVf"
        }
      },
      "deleted-by": {
        "data": null
      }
    }
  }
}

Response 202

HideShow

Body

{
  "data": {
    "id": "RaF56o2r58hTKT7AYS9doj",
    "type": "pages",
    "attributes": {
      "name": "Technology Sector News",
      "key": "tech-sector",
      "url": "https://www.omnigage.io/tech-sector",
      "description": "Most recent news on the technology sector.",
      "visibility": "public",
      "status": "pending",
      "count-subscribers": 28335,
      "count-posts": 157,
      "is-active": true,
      "is-archived": false,
      "created-at": "2020-01-01T00:00:00+00:00",
      "updated-at": "2020-01-01T00:00:00+00:00",
      "deleted-at": null
    },
    "relationships": {
      "primary": {
        "data": {
          "type": "pages",
          "id": "RaF56o2r58hTKT7AYS9doj"
        }
      },
      "published": {
        "data": {
          "type": "pages",
          "id": "KR7C7WgdvytxeTSP3dZskV"
        }
      },
      "revision": {
        "data": {
          "type": "pages",
          "id": "KR7C7WgdvytxeTSP3dZskV"
        }
      },
      "revisions": {
        "links": {
          "related": "/pages/RaF56o2r58hTKT7AYS9doj/revisions"
        }
      },
      "subscriptions": {
        "links": {
          "related": "/subscriptions?filter[page.id]=RaF56o2r58hTKT7AYS9doj"
        }
      },
      "reviews": {
        "links": {
          "related": "/reviews?filter[page.id]=RaF56o2r58hTKT7AYS9doj"
        }
      },
      "image": {
        "data": {
          "type": "files",
          "id": "iwx7c9SwZp6yPRZfqheQUL"
        }
      },
      "created-by": {
        "data": {
          "type": "memberships",
          "id": "C7xWERND6yBTpJJVHACzVf"
        }
      },
      "updated-by": {
        "data": {
          "type": "memberships",
          "id": "C7xWERND6yBTpJJVHACzVf"
        }
      },
      "deleted-by": {
        "data": null
      }
    }
  }
}

Delete Page
DELETE`/pages/`

Sets the is-archived field’s value to true. Note: The actual instance is not deleted.

Example URI

DELETE https://api.omnigage.io/api/v1/pages/

Response 204

Page Revision Collection ¶

This resource manages the retrieval of a given page’s revisions.

Note: Revisions cannot be edited or deleted.

Retrieve Page Revisions
GET`/pages/revisions{?include,filter,sort,page}`

Retrieve a collection of page revisions.

Example URI

GET https://api.omnigage.io/api/v1/pages/revisions?include=&filter=1&sort=created-at&page=10

URI Parameters

HideShow

include: string (optional)
Include one ore more related relationships using comma separated name.
sort: string (optional) Example: created-at
Sort on one or more fields using comma separated values.
filter: string (optional) Example: 1
Filter on one or more fields using comma separated values filter[field]=1,2.
page: string (optional) Example: 10
Use page[limit]=10 to reduce the number of instances returned. Use ?page[offset]=10 to skip this many instances.

Response 200

HideShow

Body

{
  "links": {
    "self": "/pages",
    "next": "/pages?page[offset]=10",
    "last": "/pages?page[offset]=100"
  },
  "meta": {
    "total": 110
  },
  "data": [
    {
      "id": "RaF56o2r58hTKT7AYS9doj",
      "type": "pages",
      "attributes": {
        "name": "Technology Sector News",
        "key": "tech-sector",
        "url": "https://www.omnigage.io/tech-sector",
        "description": "Most recent news on the technology sector.",
        "visibility": "public",
        "status": "pending",
        "count-subscribers": 28335,
        "count-posts": 157,
        "is-active": true,
        "is-archived": false,
        "created-at": "2020-01-01T00:00:00+00:00",
        "updated-at": "2020-01-01T00:00:00+00:00",
        "deleted-at": null
      },
      "relationships": {
        "primary": {
          "data": {
            "type": "pages",
            "id": "RaF56o2r58hTKT7AYS9doj"
          }
        },
        "published": {
          "data": {
            "type": "pages",
            "id": "KR7C7WgdvytxeTSP3dZskV"
          }
        },
        "revision": {
          "data": {
            "type": "pages",
            "id": "KR7C7WgdvytxeTSP3dZskV"
          }
        },
        "revisions": {
          "links": {
            "related": "/pages/RaF56o2r58hTKT7AYS9doj/revisions"
          }
        },
        "subscriptions": {
          "links": {
            "related": "/subscriptions?filter[page.id]=RaF56o2r58hTKT7AYS9doj"
          }
        },
        "reviews": {
          "links": {
            "related": "/reviews?filter[page.id]=RaF56o2r58hTKT7AYS9doj"
          }
        },
        "image": {
          "data": {
            "type": "files",
            "id": "iwx7c9SwZp6yPRZfqheQUL"
          }
        },
        "created-by": {
          "data": {
            "type": "memberships",
            "id": "C7xWERND6yBTpJJVHACzVf"
          }
        },
        "updated-by": {
          "data": {
            "type": "memberships",
            "id": "C7xWERND6yBTpJJVHACzVf"
          }
        },
        "deleted-by": {
          "data": null
        }
      }
    }
  ]
}

Page Revision ¶

This resource manages retrieving a specified page revision instance.

Retrieve Page Revision
GET`/pages/revisions/`

Retrieve an existing page revision instance.

Example URI

GET https://api.omnigage.io/api/v1/pages/revisions/

Response 200

HideShow

Body

{
  "data": {
    "id": "RaF56o2r58hTKT7AYS9doj",
    "type": "pages",
    "attributes": {
      "name": "Technology Sector News",
      "key": "tech-sector",
      "url": "https://www.omnigage.io/tech-sector",
      "description": "Most recent news on the technology sector.",
      "visibility": "public",
      "status": "pending",
      "count-subscribers": 28335,
      "count-posts": 157,
      "is-active": true,
      "is-archived": false,
      "created-at": "2020-01-01T00:00:00+00:00",
      "updated-at": "2020-01-01T00:00:00+00:00",
      "deleted-at": null
    },
    "relationships": {
      "primary": {
        "data": {
          "type": "pages",
          "id": "RaF56o2r58hTKT7AYS9doj"
        }
      },
      "published": {
        "data": {
          "type": "pages",
          "id": "KR7C7WgdvytxeTSP3dZskV"
        }
      },
      "revision": {
        "data": {
          "type": "pages",
          "id": "KR7C7WgdvytxeTSP3dZskV"
        }
      },
      "revisions": {
        "links": {
          "related": "/pages/RaF56o2r58hTKT7AYS9doj/revisions"
        }
      },
      "subscriptions": {
        "links": {
          "related": "/subscriptions?filter[page.id]=RaF56o2r58hTKT7AYS9doj"
        }
      },
      "reviews": {
        "links": {
          "related": "/reviews?filter[page.id]=RaF56o2r58hTKT7AYS9doj"
        }
      },
      "image": {
        "data": {
          "type": "files",
          "id": "iwx7c9SwZp6yPRZfqheQUL"
        }
      },
      "created-by": {
        "data": {
          "type": "memberships",
          "id": "C7xWERND6yBTpJJVHACzVf"
        }
      },
      "updated-by": {
        "data": {
          "type": "memberships",
          "id": "C7xWERND6yBTpJJVHACzVf"
        }
      },
      "deleted-by": {
        "data": null
      }
    }
  }
}

Page Collaborator Collection ¶

This resource manages the retrieval of collaborator collections and the creation of collaborator instances.

Retrieve Page Collaborators
GET`/pages/collaborators{?include,sort,filter,page}`

Retrieve a collection of collaborators.

Example URI

GET https://api.omnigage.io/api/v1/pages/collaborators?include=&sort=created-at&filter=1&page=10

URI Parameters

HideShow

include: string (optional)
Include one ore more related relationships using comma separated name.
sort: string (optional) Example: created-at
Sort on one or more fields using comma separated values.
filter: string (optional) Example: 1
Filter on one or more fields using comma separated values filter[field]=1,2.
page: string (optional) Example: 10
Use page[limit]=10 to reduce the number of instances returned. Use ?page[offset]=10 to skip this many instances.

Response 200

HideShow

Body

{
  "links": {
    "self": "/pages/97iQjGNFLTZ5oxfYTKinwo/collaborators",
    "next": "/pages/97iQjGNFLTZ5oxfYTKinwo/collaborators?page[offset]=10",
    "last": "/pages/97iQjGNFLTZ5oxfYTKinwo/collaborators?page[offset]=100"
  },
  "meta": {
    "total": 1
  },
  "data": [
    {
      "id": "RaF56o2r58hTKT7AYS9doj",
      "type": "pages-collaborators",
      "attributes": {
        "permission": "write",
        "is-archived": false,
        "created-at": "2020-01-01T00:00:00+00:00",
        "updated-at": "2020-01-01T00:00:00+00:00",
        "deleted-at": null
      },
      "relationships": {
        "membership": {
          "data": {
            "type": "memberships",
            "id": "6jVhCt5kE2p6e7B7SX9CGe"
          }
        },
        "team": {
          "data": null
        },
        "page": {
          "data": {
            "type": "pages",
            "id": "97iQjGNFLTZ5oxfYTKinwo"
          }
        },
        "created-by": {
          "data": {
            "type": "memberships",
            "id": "C7xWERND6yBTpJJVHACzVf"
          }
        },
        "updated-by": {
          "data": {
            "type": "memberships",
            "id": "C7xWERND6yBTpJJVHACzVf"
          }
        },
        "deleted-by": {
          "data": null
        }
      }
    }
  ]
}

Create Page Collaborator
POST`/pages/collaborators`

Create a new collaborator instance.

Example URI

POST https://api.omnigage.io/api/v1/pages/collaborators

Request

HideShow

Body

{
  "data": {
    "type": "pages-collaborators",
    "attributes": {
      "permission": "write"
    },
    "relationships": {
      "membership": {
        "data": {
          "type": "memberships",
          "id": "6jVhCt5kE2p6e7B7SX9CGe"
        }
      },
      "page": {
        "data": {
          "type": "pages",
          "id": "97iQjGNFLTZ5oxfYTKinwo"
        }
      }
    }
  }
}

Response 201

HideShow

Body

{
  "data": {
    "id": "RaF56o2r58hTKT7AYS9doj",
    "type": "pages-collaborators",
    "attributes": {
      "permission": "write",
      "is-archived": false,
      "created-at": "2020-01-01T00:00:00+00:00",
      "updated-at": "2020-01-01T00:00:00+00:00",
      "deleted-at": null
    },
    "relationships": {
      "membership": {
        "data": {
          "type": "memberships",
          "id": "6jVhCt5kE2p6e7B7SX9CGe"
        }
      },
      "team": {
        "data": null
      },
      "page": {
        "data": {
          "type": "pages",
          "id": "97iQjGNFLTZ5oxfYTKinwo"
        }
      },
      "created-by": {
        "data": {
          "type": "memberships",
          "id": "C7xWERND6yBTpJJVHACzVf"
        }
      },
      "updated-by": {
        "data": {
          "type": "memberships",
          "id": "C7xWERND6yBTpJJVHACzVf"
        }
      },
      "deleted-by": {
        "data": null
      }
    }
  }
}

Page Collaborator ¶

This resource manages updating and retrieving a specified collaborator instance.

Retrieve Page Collaborator
GET`/pages/collaborators/`

Retrieve an existing collaborator instance.

Example URI

GET https://api.omnigage.io/api/v1/pages/collaborators/

Response 200

HideShow

Body

{
  "data": {
    "id": "RaF56o2r58hTKT7AYS9doj",
    "type": "pages-collaborators",
    "attributes": {
      "permission": "write",
      "is-archived": false,
      "created-at": "2020-01-01T00:00:00+00:00",
      "updated-at": "2020-01-01T00:00:00+00:00",
      "deleted-at": null
    },
    "relationships": {
      "membership": {
        "data": {
          "type": "memberships",
          "id": "6jVhCt5kE2p6e7B7SX9CGe"
        }
      },
      "team": {
        "data": null
      },
      "page": {
        "data": {
          "type": "pages",
          "id": "97iQjGNFLTZ5oxfYTKinwo"
        }
      },
      "created-by": {
        "data": {
          "type": "memberships",
          "id": "C7xWERND6yBTpJJVHACzVf"
        }
      },
      "updated-by": {
        "data": {
          "type": "memberships",
          "id": "C7xWERND6yBTpJJVHACzVf"
        }
      },
      "deleted-by": {
        "data": null
      }
    }
  }
}

Update Page Collaborator
PATCH`/pages/collaborators/`

Update an existing collaborator instance.

Note: A membership cannot edit their own instance.

Example URI

PATCH https://api.omnigage.io/api/v1/pages/collaborators/

Request

HideShow

Body

{
  "data": {
    "id": "RaF56o2r58hTKT7AYS9doj",
    "type": "pages-collaborators",
    "attributes": {
      "permission": "write",
      "is-archived": false,
      "created-at": "2020-01-01T00:00:00+00:00",
      "updated-at": "2020-01-01T00:00:00+00:00",
      "deleted-at": null
    },
    "relationships": {
      "membership": {
        "data": {
          "type": "memberships",
          "id": "6jVhCt5kE2p6e7B7SX9CGe"
        }
      },
      "team": {
        "data": null
      },
      "page": {
        "data": {
          "type": "pages",
          "id": "97iQjGNFLTZ5oxfYTKinwo"
        }
      },
      "created-by": {
        "data": {
          "type": "memberships",
          "id": "C7xWERND6yBTpJJVHACzVf"
        }
      },
      "updated-by": {
        "data": {
          "type": "memberships",
          "id": "C7xWERND6yBTpJJVHACzVf"
        }
      },
      "deleted-by": {
        "data": null
      }
    }
  }
}

Response 202

HideShow

Body

{
  "data": {
    "id": "RaF56o2r58hTKT7AYS9doj",
    "type": "pages-collaborators",
    "attributes": {
      "permission": "write",
      "is-archived": false,
      "created-at": "2020-01-01T00:00:00+00:00",
      "updated-at": "2020-01-01T00:00:00+00:00",
      "deleted-at": null
    },
    "relationships": {
      "membership": {
        "data": {
          "type": "memberships",
          "id": "6jVhCt5kE2p6e7B7SX9CGe"
        }
      },
      "team": {
        "data": null
      },
      "page": {
        "data": {
          "type": "pages",
          "id": "97iQjGNFLTZ5oxfYTKinwo"
        }
      },
      "created-by": {
        "data": {
          "type": "memberships",
          "id": "C7xWERND6yBTpJJVHACzVf"
        }
      },
      "updated-by": {
        "data": {
          "type": "memberships",
          "id": "C7xWERND6yBTpJJVHACzVf"
        }
      },
      "deleted-by": {
        "data": null
      }
    }
  }
}

Delete Page Collaborator
DELETE`/pages/collaborators/`

Sets the is-archived field’s value to true. Note: The actual instance is not deleted.

Note: A membership cannot delete their own instance.

Example URI

DELETE https://api.omnigage.io/api/v1/pages/collaborators/

Response 204

Subscription Collection ¶

This resource manages the retrieval of subscription collections and the creation of subscription instances.

Retrieve Subscriptions
GET`/subscriptions{?include,sort,filter,page}`

Retrieve a collection of subscriptions.

Example URI

GET https://api.omnigage.io/api/v1/subscriptions?include=&sort=created-at&filter=1&page=10

URI Parameters

HideShow

filter: string (required) Example: 1
include: string (optional)
Include one ore more related relationships using comma separated name.
sort: string (optional) Example: created-at
page: string (optional) Example: 10

Response 200

HideShow

Body

{
  "links": {
    "self": "/subscriptions",
    "next": "/subscriptions?page[offset]=10&filter[page.id]=VGJfk5QBEEjtXwBswXcPjJ",
    "last": "/subscriptions?page[offset]=100&filter[page.id]=VGJfk5QBEEjtXwBswXcPjJ"
  },
  "meta": {
    "total": 1
  },
  "data": [
    {
      "id": "RaF56o2r58hTKT7AYS9doj",
      "type": "subscriptions",
      "attributes": {
        "status": "pending",
        "email-address": "alexander.bell@bell-labs.com",
        "direction": "outbound",
        "is-archived": false,
        "created-at": "2020-01-01T00:00:00+00:00",
        "updated-at": "2020-01-01T00:00:00+00:00",
        "deleted-at": null
      },
      "relationships": {
        "page": {
          "data": {
            "type": "pages",
            "id": "VGJfk5QBEEjtXwBswXcPjJ"
          }
        },
        "user": {
          "data": {
            "type": "users",
            "id": "c8sh5y9hdSMS6zVnrvf53T"
          }
        },
        "created-by": {
          "data": {
            "type": "memberships",
            "id": "C7xWERND6yBTpJJVHACzVf"
          }
        },
        "updated-by": {
          "data": {
            "type": "memberships",
            "id": "C7xWERND6yBTpJJVHACzVf"
          }
        },
        "deleted-by": {
          "data": null
        }
      }
    }
  ]
}

Create Subscription
POST`/subscriptions`

Create a new subscription instance.

Example URI

POST https://api.omnigage.io/api/v1/subscriptions

Request

HideShow

Body

{
  "data": {
    "type": "subscriptions",
    "attributes": {
      "email-address": "alexander.bell@bell-labs.com"
    },
    "relationships": {
      "page": {
        "data": {
          "type": "pages",
          "id": "VGJfk5QBEEjtXwBswXcPjJ"
        }
      }
    }
  }
}

Response 201

HideShow

Body

{
  "data": {
    "id": "RaF56o2r58hTKT7AYS9doj",
    "type": "subscriptions",
    "attributes": {
      "status": "pending",
      "email-address": "alexander.bell@bell-labs.com",
      "direction": "outbound",
      "is-archived": false,
      "created-at": "2020-01-01T00:00:00+00:00",
      "updated-at": "2020-01-01T00:00:00+00:00",
      "deleted-at": null
    },
    "relationships": {
      "page": {
        "data": {
          "type": "pages",
          "id": "VGJfk5QBEEjtXwBswXcPjJ"
        }
      },
      "user": {
        "data": {
          "type": "users",
          "id": "c8sh5y9hdSMS6zVnrvf53T"
        }
      },
      "created-by": {
        "data": {
          "type": "memberships",
          "id": "C7xWERND6yBTpJJVHACzVf"
        }
      },
      "updated-by": {
        "data": {
          "type": "memberships",
          "id": "C7xWERND6yBTpJJVHACzVf"
        }
      },
      "deleted-by": {
        "data": null
      }
    }
  }
}

Subscription ¶

This resource manages updating and retrieving a specified subscription instance.

Retrieve Subscription
GET`/subscriptions/`

Retrieve an existing subscription instance.

Example URI

GET https://api.omnigage.io/api/v1/subscriptions/

Response 200

HideShow

Body

{
  "data": {
    "id": "RaF56o2r58hTKT7AYS9doj",
    "type": "subscriptions",
    "attributes": {
      "status": "pending",
      "email-address": "alexander.bell@bell-labs.com",
      "direction": "outbound",
      "is-archived": false,
      "created-at": "2020-01-01T00:00:00+00:00",
      "updated-at": "2020-01-01T00:00:00+00:00",
      "deleted-at": null
    },
    "relationships": {
      "page": {
        "data": {
          "type": "pages",
          "id": "VGJfk5QBEEjtXwBswXcPjJ"
        }
      },
      "user": {
        "data": {
          "type": "users",
          "id": "c8sh5y9hdSMS6zVnrvf53T"
        }
      },
      "created-by": {
        "data": {
          "type": "memberships",
          "id": "C7xWERND6yBTpJJVHACzVf"
        }
      },
      "updated-by": {
        "data": {
          "type": "memberships",
          "id": "C7xWERND6yBTpJJVHACzVf"
        }
      },
      "deleted-by": {
        "data": null
      }
    }
  }
}

Update Subscription
PATCH`/subscriptions/`

Update an existing subscription instance.

Example URI

PATCH https://api.omnigage.io/api/v1/subscriptions/

Request

HideShow

Body

{
  "data": {
    "id": "RaF56o2r58hTKT7AYS9doj",
    "type": "subscriptions",
    "attributes": {
      "status": "pending",
      "email-address": "alexander.bell@bell-labs.com",
      "direction": "outbound",
      "is-archived": false,
      "created-at": "2020-01-01T00:00:00+00:00",
      "updated-at": "2020-01-01T00:00:00+00:00",
      "deleted-at": null
    },
    "relationships": {
      "page": {
        "data": {
          "type": "pages",
          "id": "VGJfk5QBEEjtXwBswXcPjJ"
        }
      },
      "user": {
        "data": {
          "type": "users",
          "id": "c8sh5y9hdSMS6zVnrvf53T"
        }
      },
      "created-by": {
        "data": {
          "type": "memberships",
          "id": "C7xWERND6yBTpJJVHACzVf"
        }
      },
      "updated-by": {
        "data": {
          "type": "memberships",
          "id": "C7xWERND6yBTpJJVHACzVf"
        }
      },
      "deleted-by": {
        "data": null
      }
    }
  }
}

Response 202

HideShow

Body

{
  "data": {
    "id": "RaF56o2r58hTKT7AYS9doj",
    "type": "subscriptions",
    "attributes": {
      "status": "pending",
      "email-address": "alexander.bell@bell-labs.com",
      "direction": "outbound",
      "is-archived": false,
      "created-at": "2020-01-01T00:00:00+00:00",
      "updated-at": "2020-01-01T00:00:00+00:00",
      "deleted-at": null
    },
    "relationships": {
      "page": {
        "data": {
          "type": "pages",
          "id": "VGJfk5QBEEjtXwBswXcPjJ"
        }
      },
      "user": {
        "data": {
          "type": "users",
          "id": "c8sh5y9hdSMS6zVnrvf53T"
        }
      },
      "created-by": {
        "data": {
          "type": "memberships",
          "id": "C7xWERND6yBTpJJVHACzVf"
        }
      },
      "updated-by": {
        "data": {
          "type": "memberships",
          "id": "C7xWERND6yBTpJJVHACzVf"
        }
      },
      "deleted-by": {
        "data": null
      }
    }
  }
}

Delete Subscription
DELETE`/subscriptions/`

Sets the is-archived field’s value to true. Note: The actual instance is not deleted.

Example URI

DELETE https://api.omnigage.io/api/v1/subscriptions/

Response 204

Post Collection ¶

This resource manages the retrieval of post collections and the creation of post instances.

Retrieve Posts
GET`/posts{?include,filter,sort,page}`

Retrieve a collection of posts.

Example URI

GET https://api.omnigage.io/api/v1/posts?include=&filter=1&sort=created-at&page=10

URI Parameters

HideShow

include: string (optional)
Include one ore more related relationships using comma separated name.
sort: string (optional) Example: created-at
Sort on one or more fields using comma separated values.
filter: string (optional) Example: 1
Filter on one or more fields using comma separated values filter[field]=1,2.
page: string (optional) Example: 10
Use page[limit]=10 to reduce the number of instances returned. Use ?page[offset]=10 to skip this many instances.

Response 200

HideShow

Body

{
  "links": {
    "self": "/posts",
    "next": "/posts?page[offset]=10",
    "last": "/posts?page[offset]=100"
  },
  "meta": {
    "total": 110
  },
  "data": [
    {
      "id": "RaF56o2r58hTKT7AYS9doj",
      "type": "posts",
      "attributes": {
        "title": "Big Moves in Omnichannel",
        "body": "Professional social media is coming.",
        "visibility": "public",
        "status": "pending",
        "url": "https://www.omnigage.io/tech-sector/posts/RaF56o2r58hTKT7AYS9doj",
        "count-views": 924134,
        "publish-on": "2020-09-09T16:30+00:00",
        "expires-on": "2020-09-09T20:30+00:00",
        "is-active": true,
        "is-archived": false,
        "created-at": "2020-01-01T00:00:00+00:00",
        "updated-at": "2020-01-01T00:00:00+00:00",
        "deleted-at": null
      },
      "relationships": {
        "page": {
          "data": {
            "type": "pages",
            "id": "VGJfk5QBEEjtXwBswXcPjJ"
          }
        },
        "primary": {
          "data": {
            "type": "posts",
            "id": "RaF56o2r58hTKT7AYS9doj"
          }
        },
        "published": {
          "data": {
            "type": "posts",
            "id": "KR7C7WgdvytxeTSP3dZskV"
          }
        },
        "revision": {
          "data": {
            "type": "posts",
            "id": "KR7C7WgdvytxeTSP3dZskV"
          }
        },
        "revisions": {
          "links": {
            "related": "/posts/RaF56o2r58hTKT7AYS9doj/revisions"
          }
        },
        "reviews": {
          "links": {
            "related": "/reviews?filter[post.id]=RaF56o2r58hTKT7AYS9doj"
          }
        },
        "files": {
          "data": [
            {
              "type": "files",
              "id": "r58hTKT7AYS9dojRaF56o2"
            },
            {
              "type": "files",
              "id": "ZskVKR7C7WgdvytxeTSP3d"
            }
          ]
        },
        "created-by": {
          "data": {
            "type": "memberships",
            "id": "C7xWERND6yBTpJJVHACzVf"
          }
        },
        "updated-by": {
          "data": {
            "type": "memberships",
            "id": "C7xWERND6yBTpJJVHACzVf"
          }
        },
        "deleted-by": {
          "data": null
        }
      }
    }
  ]
}

Create Post
POST`/posts`

Create a new post instance.

Example URI

POST https://api.omnigage.io/api/v1/posts

Request

HideShow

Body

{
  "data": {
    "type": "posts",
    "attributes": {
      "title": "Big Moves in Omnichannel",
      "body": "Professional social media is coming.",
      "visibility": "private",
      "publish-on": "2020-09-09T16:30+00:00",
      "expires-on": "2020-09-09T20:30+00:00",
      "is-active": true
    },
    "relationships": {
      "page": {
        "data": {
          "type": "pages",
          "id": "VGJfk5QBEEjtXwBswXcPjJ"
        }
      },
      "uploads": {
        "data": [
          {
            "type": "uploads",
            "id": "QNW3gbarNKESMwyirEE7t8"
          },
          {
            "type": "uploads",
            "id": "xzkVnXHXBWj3W2eoki7oLP"
          }
        ]
      }
    }
  }
}

Response 201

HideShow

Body

{
  "data": {
    "id": "RaF56o2r58hTKT7AYS9doj",
    "type": "posts",
    "attributes": {
      "title": "Big Moves in Omnichannel",
      "body": "Professional social media is coming.",
      "visibility": "public",
      "status": "pending",
      "url": "https://www.omnigage.io/tech-sector/posts/RaF56o2r58hTKT7AYS9doj",
      "count-views": 924134,
      "publish-on": "2020-09-09T16:30+00:00",
      "expires-on": "2020-09-09T20:30+00:00",
      "is-active": true,
      "is-archived": false,
      "created-at": "2020-01-01T00:00:00+00:00",
      "updated-at": "2020-01-01T00:00:00+00:00",
      "deleted-at": null
    },
    "relationships": {
      "page": {
        "data": {
          "type": "pages",
          "id": "VGJfk5QBEEjtXwBswXcPjJ"
        }
      },
      "primary": {
        "data": {
          "type": "posts",
          "id": "RaF56o2r58hTKT7AYS9doj"
        }
      },
      "published": {
        "data": {
          "type": "posts",
          "id": "KR7C7WgdvytxeTSP3dZskV"
        }
      },
      "revision": {
        "data": {
          "type": "posts",
          "id": "KR7C7WgdvytxeTSP3dZskV"
        }
      },
      "revisions": {
        "links": {
          "related": "/posts/RaF56o2r58hTKT7AYS9doj/revisions"
        }
      },
      "reviews": {
        "links": {
          "related": "/reviews?filter[post.id]=RaF56o2r58hTKT7AYS9doj"
        }
      },
      "files": {
        "data": [
          {
            "type": "files",
            "id": "r58hTKT7AYS9dojRaF56o2"
          },
          {
            "type": "files",
            "id": "ZskVKR7C7WgdvytxeTSP3d"
          }
        ]
      },
      "created-by": {
        "data": {
          "type": "memberships",
          "id": "C7xWERND6yBTpJJVHACzVf"
        }
      },
      "updated-by": {
        "data": {
          "type": "memberships",
          "id": "C7xWERND6yBTpJJVHACzVf"
        }
      },
      "deleted-by": {
        "data": null
      }
    }
  }
}

Post ¶

This resource manages updating and retrieving a specified post instance.

Retrieve Post
GET`/posts/`

Retrieve an existing post instance.

Example URI

GET https://api.omnigage.io/api/v1/posts/

Response 200

HideShow

Body

{
  "data": {
    "id": "RaF56o2r58hTKT7AYS9doj",
    "type": "posts",
    "attributes": {
      "title": "Big Moves in Omnichannel",
      "body": "Professional social media is coming.",
      "visibility": "public",
      "status": "pending",
      "url": "https://www.omnigage.io/tech-sector/posts/RaF56o2r58hTKT7AYS9doj",
      "count-views": 924134,
      "publish-on": "2020-09-09T16:30+00:00",
      "expires-on": "2020-09-09T20:30+00:00",
      "is-active": true,
      "is-archived": false,
      "created-at": "2020-01-01T00:00:00+00:00",
      "updated-at": "2020-01-01T00:00:00+00:00",
      "deleted-at": null
    },
    "relationships": {
      "page": {
        "data": {
          "type": "pages",
          "id": "VGJfk5QBEEjtXwBswXcPjJ"
        }
      },
      "primary": {
        "data": {
          "type": "posts",
          "id": "RaF56o2r58hTKT7AYS9doj"
        }
      },
      "published": {
        "data": {
          "type": "posts",
          "id": "KR7C7WgdvytxeTSP3dZskV"
        }
      },
      "revision": {
        "data": {
          "type": "posts",
          "id": "KR7C7WgdvytxeTSP3dZskV"
        }
      },
      "revisions": {
        "links": {
          "related": "/posts/RaF56o2r58hTKT7AYS9doj/revisions"
        }
      },
      "reviews": {
        "links": {
          "related": "/reviews?filter[post.id]=RaF56o2r58hTKT7AYS9doj"
        }
      },
      "files": {
        "data": [
          {
            "type": "files",
            "id": "r58hTKT7AYS9dojRaF56o2"
          },
          {
            "type": "files",
            "id": "ZskVKR7C7WgdvytxeTSP3d"
          }
        ]
      },
      "created-by": {
        "data": {
          "type": "memberships",
          "id": "C7xWERND6yBTpJJVHACzVf"
        }
      },
      "updated-by": {
        "data": {
          "type": "memberships",
          "id": "C7xWERND6yBTpJJVHACzVf"
        }
      },
      "deleted-by": {
        "data": null
      }
    }
  }
}

Update Post
PATCH`/posts/`

Update an existing post instance.

Updating will create a new revision. This includes adding or archiving files.
The published relationship is the syndicated revision.
When a new revision is created, the previous published revision remains set.
To publish a new revision, perform an update setting the revision id as the published relationship or set the status to published.
If pre-compliance is enabled, the revision must be approved.
New revisions default to a status of pending. To publish a new revision, the status must be review-approved.

Example URI

PATCH https://api.omnigage.io/api/v1/posts/

Request

HideShow

Body

{
  "data": {
    "id": "RaF56o2r58hTKT7AYS9doj",
    "type": "posts",
    "attributes": {
      "title": "Big Moves in Omnichannel",
      "body": "Professional social media is coming.",
      "visibility": "public",
      "status": "pending",
      "url": "https://www.omnigage.io/tech-sector/posts/RaF56o2r58hTKT7AYS9doj",
      "count-views": 924134,
      "publish-on": "2020-09-09T16:30+00:00",
      "expires-on": "2020-09-09T20:30+00:00",
      "is-active": true,
      "is-archived": false,
      "created-at": "2020-01-01T00:00:00+00:00",
      "updated-at": "2020-01-01T00:00:00+00:00",
      "deleted-at": null
    },
    "relationships": {
      "page": {
        "data": {
          "type": "pages",
          "id": "VGJfk5QBEEjtXwBswXcPjJ"
        }
      },
      "primary": {
        "data": {
          "type": "posts",
          "id": "RaF56o2r58hTKT7AYS9doj"
        }
      },
      "published": {
        "data": {
          "type": "posts",
          "id": "KR7C7WgdvytxeTSP3dZskV"
        }
      },
      "revision": {
        "data": {
          "type": "posts",
          "id": "KR7C7WgdvytxeTSP3dZskV"
        }
      },
      "revisions": {
        "links": {
          "related": "/posts/RaF56o2r58hTKT7AYS9doj/revisions"
        }
      },
      "reviews": {
        "links": {
          "related": "/reviews?filter[post.id]=RaF56o2r58hTKT7AYS9doj"
        }
      },
      "files": {
        "data": [
          {
            "type": "files",
            "id": "r58hTKT7AYS9dojRaF56o2"
          },
          {
            "type": "files",
            "id": "ZskVKR7C7WgdvytxeTSP3d"
          }
        ]
      },
      "created-by": {
        "data": {
          "type": "memberships",
          "id": "C7xWERND6yBTpJJVHACzVf"
        }
      },
      "updated-by": {
        "data": {
          "type": "memberships",
          "id": "C7xWERND6yBTpJJVHACzVf"
        }
      },
      "deleted-by": {
        "data": null
      }
    }
  }
}

Response 202

HideShow

Body

{
  "data": {
    "id": "RaF56o2r58hTKT7AYS9doj",
    "type": "posts",
    "attributes": {
      "title": "Big Moves in Omnichannel",
      "body": "Professional social media is coming.",
      "visibility": "public",
      "status": "pending",
      "url": "https://www.omnigage.io/tech-sector/posts/RaF56o2r58hTKT7AYS9doj",
      "count-views": 924134,
      "publish-on": "2020-09-09T16:30+00:00",
      "expires-on": "2020-09-09T20:30+00:00",
      "is-active": true,
      "is-archived": false,
      "created-at": "2020-01-01T00:00:00+00:00",
      "updated-at": "2020-01-01T00:00:00+00:00",
      "deleted-at": null
    },
    "relationships": {
      "page": {
        "data": {
          "type": "pages",
          "id": "VGJfk5QBEEjtXwBswXcPjJ"
        }
      },
      "primary": {
        "data": {
          "type": "posts",
          "id": "RaF56o2r58hTKT7AYS9doj"
        }
      },
      "published": {
        "data": {
          "type": "posts",
          "id": "KR7C7WgdvytxeTSP3dZskV"
        }
      },
      "revision": {
        "data": {
          "type": "posts",
          "id": "KR7C7WgdvytxeTSP3dZskV"
        }
      },
      "revisions": {
        "links": {
          "related": "/posts/RaF56o2r58hTKT7AYS9doj/revisions"
        }
      },
      "reviews": {
        "links": {
          "related": "/reviews?filter[post.id]=RaF56o2r58hTKT7AYS9doj"
        }
      },
      "files": {
        "data": [
          {
            "type": "files",
            "id": "r58hTKT7AYS9dojRaF56o2"
          },
          {
            "type": "files",
            "id": "ZskVKR7C7WgdvytxeTSP3d"
          }
        ]
      },
      "created-by": {
        "data": {
          "type": "memberships",
          "id": "C7xWERND6yBTpJJVHACzVf"
        }
      },
      "updated-by": {
        "data": {
          "type": "memberships",
          "id": "C7xWERND6yBTpJJVHACzVf"
        }
      },
      "deleted-by": {
        "data": null
      }
    }
  }
}

Delete Post
DELETE`/posts/`

Sets the is-archived field’s value to true. Note: The actual instance is not deleted.

Example URI

DELETE https://api.omnigage.io/api/v1/posts/

Response 204

Post Revision Collection ¶

This resource manages the retrieval of a given post’s revisions.

Note: Revisions cannot be edited or deleted.

Retrieve Post Revisions
GET`/posts/revisions{?include,filter,sort,page}`

Retrieve a collection of post revisions.

Example URI

GET https://api.omnigage.io/api/v1/posts/revisions?include=&filter=1&sort=created-at&page=10

URI Parameters

HideShow

include: string (optional)
Include one ore more related relationships using comma separated name.
sort: string (optional) Example: created-at
Sort on one or more fields using comma separated values.
filter: string (optional) Example: 1
Filter on one or more fields using comma separated values filter[field]=1,2.
page: string (optional) Example: 10
Use page[limit]=10 to reduce the number of instances returned. Use ?page[offset]=10 to skip this many instances.

Response 200

HideShow

Body

{
  "links": {
    "self": "/posts",
    "next": "/posts?page[offset]=10",
    "last": "/posts?page[offset]=100"
  },
  "meta": {
    "total": 110
  },
  "data": [
    {
      "id": "RaF56o2r58hTKT7AYS9doj",
      "type": "posts",
      "attributes": {
        "title": "Big Moves in Omnichannel",
        "body": "Professional social media is coming.",
        "visibility": "public",
        "status": "pending",
        "url": "https://www.omnigage.io/tech-sector/posts/RaF56o2r58hTKT7AYS9doj",
        "count-views": 924134,
        "publish-on": "2020-09-09T16:30+00:00",
        "expires-on": "2020-09-09T20:30+00:00",
        "is-active": true,
        "is-archived": false,
        "created-at": "2020-01-01T00:00:00+00:00",
        "updated-at": "2020-01-01T00:00:00+00:00",
        "deleted-at": null
      },
      "relationships": {
        "page": {
          "data": {
            "type": "pages",
            "id": "VGJfk5QBEEjtXwBswXcPjJ"
          }
        },
        "primary": {
          "data": {
            "type": "posts",
            "id": "RaF56o2r58hTKT7AYS9doj"
          }
        },
        "published": {
          "data": {
            "type": "posts",
            "id": "KR7C7WgdvytxeTSP3dZskV"
          }
        },
        "revision": {
          "data": {
            "type": "posts",
            "id": "KR7C7WgdvytxeTSP3dZskV"
          }
        },
        "revisions": {
          "links": {
            "related": "/posts/RaF56o2r58hTKT7AYS9doj/revisions"
          }
        },
        "reviews": {
          "links": {
            "related": "/reviews?filter[post.id]=RaF56o2r58hTKT7AYS9doj"
          }
        },
        "files": {
          "data": [
            {
              "type": "files",
              "id": "r58hTKT7AYS9dojRaF56o2"
            },
            {
              "type": "files",
              "id": "ZskVKR7C7WgdvytxeTSP3d"
            }
          ]
        },
        "created-by": {
          "data": {
            "type": "memberships",
            "id": "C7xWERND6yBTpJJVHACzVf"
          }
        },
        "updated-by": {
          "data": {
            "type": "memberships",
            "id": "C7xWERND6yBTpJJVHACzVf"
          }
        },
        "deleted-by": {
          "data": null
        }
      }
    }
  ]
}

Post Revision ¶

This resource manages retrieving a specified post revision instance.

Retrieve Post Revision
GET`/posts/revisions/`

Retrieve an existing post revision instance.

Example URI

GET https://api.omnigage.io/api/v1/posts/revisions/

Response 200

HideShow

Body

{
  "data": {
    "id": "RaF56o2r58hTKT7AYS9doj",
    "type": "posts",
    "attributes": {
      "title": "Big Moves in Omnichannel",
      "body": "Professional social media is coming.",
      "visibility": "public",
      "status": "pending",
      "url": "https://www.omnigage.io/tech-sector/posts/RaF56o2r58hTKT7AYS9doj",
      "count-views": 924134,
      "publish-on": "2020-09-09T16:30+00:00",
      "expires-on": "2020-09-09T20:30+00:00",
      "is-active": true,
      "is-archived": false,
      "created-at": "2020-01-01T00:00:00+00:00",
      "updated-at": "2020-01-01T00:00:00+00:00",
      "deleted-at": null
    },
    "relationships": {
      "page": {
        "data": {
          "type": "pages",
          "id": "VGJfk5QBEEjtXwBswXcPjJ"
        }
      },
      "primary": {
        "data": {
          "type": "posts",
          "id": "RaF56o2r58hTKT7AYS9doj"
        }
      },
      "published": {
        "data": {
          "type": "posts",
          "id": "KR7C7WgdvytxeTSP3dZskV"
        }
      },
      "revision": {
        "data": {
          "type": "posts",
          "id": "KR7C7WgdvytxeTSP3dZskV"
        }
      },
      "revisions": {
        "links": {
          "related": "/posts/RaF56o2r58hTKT7AYS9doj/revisions"
        }
      },
      "reviews": {
        "links": {
          "related": "/reviews?filter[post.id]=RaF56o2r58hTKT7AYS9doj"
        }
      },
      "files": {
        "data": [
          {
            "type": "files",
            "id": "r58hTKT7AYS9dojRaF56o2"
          },
          {
            "type": "files",
            "id": "ZskVKR7C7WgdvytxeTSP3d"
          }
        ]
      },
      "created-by": {
        "data": {
          "type": "memberships",
          "id": "C7xWERND6yBTpJJVHACzVf"
        }
      },
      "updated-by": {
        "data": {
          "type": "memberships",
          "id": "C7xWERND6yBTpJJVHACzVf"
        }
      },
      "deleted-by": {
        "data": null
      }
    }
  }
}

Teams Resources ¶

Team Collection ¶

This resource manages the retrieval of team collections and the creation of team instances.

Note: Visibility is restricted based on membership of the team or if the team is not private. An account admin can view all teams.

Retrieve Teams
GET`/teams{?include,filter,sort,page}`

Retrieve a collection of teams.

Example URI

GET https://api.omnigage.io/api/v1/teams?include=&filter=1&sort=created-at&page=10

URI Parameters

HideShow

include: string (optional)
Include one ore more related relationships using comma separated name.
sort: string (optional) Example: created-at
Sort on one or more fields using comma separated values.
filter: string (optional) Example: 1
Filter on one or more fields using comma separated values filter[field]=1,2.
page: string (optional) Example: 10
Use page[limit]=10 to reduce the number of instances returned. Use ?page[offset]=10 to skip this many instances.

Response 200

HideShow

Body

{
  "links": {
    "self": "/teams",
    "next": "/teams?page[offset]=10",
    "last": "/teams?page[offset]=100"
  },
  "meta": {
    "total": 110
  },
  "data": [
    {
      "id": "RaF56o2r58hTKT7AYS9doj",
      "type": "teams",
      "attributes": {
        "name": "SEAL Team Six",
        "is-private": false,
        "is-active": true,
        "is-archived": false,
        "created-at": "2020-01-01T00:00:00+00:00",
        "updated-at": "2020-01-01T00:00:00+00:00",
        "deleted-at": null
      },
      "relationships": {
        "members": {
          "links": {
            "related": "/teams/RaF56o2r58hTKT7AYS9doj/members"
          }
        },
        "created-by": {
          "data": {
            "type": "memberships",
            "id": "C7xWERND6yBTpJJVHACzVf"
          }
        },
        "updated-by": {
          "data": {
            "type": "memberships",
            "id": "C7xWERND6yBTpJJVHACzVf"
          }
        },
        "deleted-by": {
          "data": null
        }
      }
    }
  ]
}

Create Team
POST`/teams`

Create a new team instance.

Note: Only account admins can create teams.

Example URI

POST https://api.omnigage.io/api/v1/teams

Request

HideShow

Body

{
  "data": {
    "type": "teams",
    "attributes": {
      "name": "SEAL Team Six",
      "is-private": false,
      "is-active": true
    }
  }
}

Response 201

HideShow

Body

{
  "data": {
    "id": "RaF56o2r58hTKT7AYS9doj",
    "type": "teams",
    "attributes": {
      "name": "SEAL Team Six",
      "is-private": false,
      "is-active": true,
      "is-archived": false,
      "created-at": "2020-01-01T00:00:00+00:00",
      "updated-at": "2020-01-01T00:00:00+00:00",
      "deleted-at": null
    },
    "relationships": {
      "members": {
        "links": {
          "related": "/teams/RaF56o2r58hTKT7AYS9doj/members"
        }
      },
      "created-by": {
        "data": {
          "type": "memberships",
          "id": "C7xWERND6yBTpJJVHACzVf"
        }
      },
      "updated-by": {
        "data": {
          "type": "memberships",
          "id": "C7xWERND6yBTpJJVHACzVf"
        }
      },
      "deleted-by": {
        "data": null
      }
    }
  }
}

Team ¶

This resource manages updating and retrieving a specified team instance.

Retrieve Team
GET`/teams/`

Retrieve an existing team instance.

Example URI

GET https://api.omnigage.io/api/v1/teams/

Response 200

HideShow

Body

{
  "data": {
    "id": "RaF56o2r58hTKT7AYS9doj",
    "type": "teams",
    "attributes": {
      "name": "SEAL Team Six",
      "is-private": false,
      "is-active": true,
      "is-archived": false,
      "created-at": "2020-01-01T00:00:00+00:00",
      "updated-at": "2020-01-01T00:00:00+00:00",
      "deleted-at": null
    },
    "relationships": {
      "members": {
        "links": {
          "related": "/teams/RaF56o2r58hTKT7AYS9doj/members"
        }
      },
      "created-by": {
        "data": {
          "type": "memberships",
          "id": "C7xWERND6yBTpJJVHACzVf"
        }
      },
      "updated-by": {
        "data": {
          "type": "memberships",
          "id": "C7xWERND6yBTpJJVHACzVf"
        }
      },
      "deleted-by": {
        "data": null
      }
    }
  }
}

Update Team
PATCH`/teams/`

Update an existing team instance.

Note: Only account admins can update teams.

Example URI

PATCH https://api.omnigage.io/api/v1/teams/

Request

HideShow

Body

{
  "data": {
    "id": "RaF56o2r58hTKT7AYS9doj",
    "type": "teams",
    "attributes": {
      "name": "SEAL Team Six",
      "is-private": false,
      "is-active": true,
      "is-archived": false,
      "created-at": "2020-01-01T00:00:00+00:00",
      "updated-at": "2020-01-01T00:00:00+00:00",
      "deleted-at": null
    },
    "relationships": {
      "members": {
        "links": {
          "related": "/teams/RaF56o2r58hTKT7AYS9doj/members"
        }
      },
      "created-by": {
        "data": {
          "type": "memberships",
          "id": "C7xWERND6yBTpJJVHACzVf"
        }
      },
      "updated-by": {
        "data": {
          "type": "memberships",
          "id": "C7xWERND6yBTpJJVHACzVf"
        }
      },
      "deleted-by": {
        "data": null
      }
    }
  }
}

Response 202

HideShow

Body

{
  "data": {
    "id": "RaF56o2r58hTKT7AYS9doj",
    "type": "teams",
    "attributes": {
      "name": "SEAL Team Six",
      "is-private": false,
      "is-active": true,
      "is-archived": false,
      "created-at": "2020-01-01T00:00:00+00:00",
      "updated-at": "2020-01-01T00:00:00+00:00",
      "deleted-at": null
    },
    "relationships": {
      "members": {
        "links": {
          "related": "/teams/RaF56o2r58hTKT7AYS9doj/members"
        }
      },
      "created-by": {
        "data": {
          "type": "memberships",
          "id": "C7xWERND6yBTpJJVHACzVf"
        }
      },
      "updated-by": {
        "data": {
          "type": "memberships",
          "id": "C7xWERND6yBTpJJVHACzVf"
        }
      },
      "deleted-by": {
        "data": null
      }
    }
  }
}

Delete Team
DELETE`/teams/`

Sets the is-archived field’s value to true. Note: The actual instance is not deleted.

Note: Only account admins can delete teams.

Example URI

DELETE https://api.omnigage.io/api/v1/teams/

Response 204

Team Member Collection ¶

This resource manages the retrieval of member collections and the creation of member instances.

Retrieve Team Members
GET`/teams/members{?include,sort,filter,page}`

Retrieve a collection of members.

Example URI

GET https://api.omnigage.io/api/v1/teams/members?include=&sort=created-at&filter=1&page=10

URI Parameters

HideShow

include: string (optional)
Include one ore more related relationships using comma separated name.
sort: string (optional) Example: created-at
Sort on one or more fields using comma separated values.
filter: string (optional) Example: 1
Filter on one or more fields using comma separated values filter[field]=1,2.
page: string (optional) Example: 10
Use page[limit]=10 to reduce the number of instances returned. Use ?page[offset]=10 to skip this many instances.

Response 200

HideShow

Body

{
  "links": {
    "self": "/teams/97iQjGNFLTZ5oxfYTKinwo/members",
    "next": "/teams/97iQjGNFLTZ5oxfYTKinwo/members?page[offset]=10",
    "last": "/teams/97iQjGNFLTZ5oxfYTKinwo/members?page[offset]=100"
  },
  "meta": {
    "total": 1
  },
  "data": [
    {
      "id": "RaF56o2r58hTKT7AYS9doj",
      "type": "teams-members",
      "attributes": {
        "is-archived": false,
        "created-at": "2020-01-01T00:00:00+00:00",
        "updated-at": "2020-01-01T00:00:00+00:00",
        "deleted-at": null
      },
      "relationships": {
        "team": {
          "data": {
            "type": "teams",
            "id": "97iQjGNFLTZ5oxfYTKinwo"
          }
        },
        "membership": {
          "data": {
            "type": "memberships",
            "id": "6jVhCt5kE2p6e7B7SX9CGe"
          }
        },
        "created-by": {
          "data": {
            "type": "memberships",
            "id": "C7xWERND6yBTpJJVHACzVf"
          }
        },
        "updated-by": {
          "data": {
            "type": "memberships",
            "id": "C7xWERND6yBTpJJVHACzVf"
          }
        },
        "deleted-by": {
          "data": null
        }
      }
    }
  ]
}

Create Team Member
POST`/teams/members`

Create a new member instance.

Note: Only account admins can create team members.

Example URI

POST https://api.omnigage.io/api/v1/teams/members

Request

HideShow

Body

{
  "data": {
    "type": "teams-members",
    "relationships": {
      "team": {
        "data": {
          "type": "teams",
          "id": "97iQjGNFLTZ5oxfYTKinwo"
        }
      },
      "membership": {
        "data": {
          "type": "memberships",
          "id": "6jVhCt5kE2p6e7B7SX9CGe"
        }
      }
    }
  }
}

Response 201

HideShow

Body

{
  "data": {
    "id": "RaF56o2r58hTKT7AYS9doj",
    "type": "teams-members",
    "attributes": {
      "is-archived": false,
      "created-at": "2020-01-01T00:00:00+00:00",
      "updated-at": "2020-01-01T00:00:00+00:00",
      "deleted-at": null
    },
    "relationships": {
      "team": {
        "data": {
          "type": "teams",
          "id": "97iQjGNFLTZ5oxfYTKinwo"
        }
      },
      "membership": {
        "data": {
          "type": "memberships",
          "id": "6jVhCt5kE2p6e7B7SX9CGe"
        }
      },
      "created-by": {
        "data": {
          "type": "memberships",
          "id": "C7xWERND6yBTpJJVHACzVf"
        }
      },
      "updated-by": {
        "data": {
          "type": "memberships",
          "id": "C7xWERND6yBTpJJVHACzVf"
        }
      },
      "deleted-by": {
        "data": null
      }
    }
  }
}

Team Member ¶

This resource manages updating and retrieving a specified member instance.

Retrieve Team Member
GET`/teams/members/`

Retrieve an existing member instance.

Example URI

GET https://api.omnigage.io/api/v1/teams/members/

Response 200

HideShow

Body

{
  "data": {
    "id": "RaF56o2r58hTKT7AYS9doj",
    "type": "teams-members",
    "attributes": {
      "is-archived": false,
      "created-at": "2020-01-01T00:00:00+00:00",
      "updated-at": "2020-01-01T00:00:00+00:00",
      "deleted-at": null
    },
    "relationships": {
      "team": {
        "data": {
          "type": "teams",
          "id": "97iQjGNFLTZ5oxfYTKinwo"
        }
      },
      "membership": {
        "data": {
          "type": "memberships",
          "id": "6jVhCt5kE2p6e7B7SX9CGe"
        }
      },
      "created-by": {
        "data": {
          "type": "memberships",
          "id": "C7xWERND6yBTpJJVHACzVf"
        }
      },
      "updated-by": {
        "data": {
          "type": "memberships",
          "id": "C7xWERND6yBTpJJVHACzVf"
        }
      },
      "deleted-by": {
        "data": null
      }
    }
  }
}

Update Team Member
PATCH`/teams/members/`

Update an existing member instance.

Note: Only account admins can update team members.

Example URI

PATCH https://api.omnigage.io/api/v1/teams/members/

Request

HideShow

Body

{
  "data": {
    "id": "RaF56o2r58hTKT7AYS9doj",
    "type": "teams-members",
    "attributes": {
      "is-archived": false,
      "created-at": "2020-01-01T00:00:00+00:00",
      "updated-at": "2020-01-01T00:00:00+00:00",
      "deleted-at": null
    },
    "relationships": {
      "team": {
        "data": {
          "type": "teams",
          "id": "97iQjGNFLTZ5oxfYTKinwo"
        }
      },
      "membership": {
        "data": {
          "type": "memberships",
          "id": "6jVhCt5kE2p6e7B7SX9CGe"
        }
      },
      "created-by": {
        "data": {
          "type": "memberships",
          "id": "C7xWERND6yBTpJJVHACzVf"
        }
      },
      "updated-by": {
        "data": {
          "type": "memberships",
          "id": "C7xWERND6yBTpJJVHACzVf"
        }
      },
      "deleted-by": {
        "data": null
      }
    }
  }
}

Response 202

HideShow

Body

{
  "data": {
    "id": "RaF56o2r58hTKT7AYS9doj",
    "type": "teams-members",
    "attributes": {
      "is-archived": false,
      "created-at": "2020-01-01T00:00:00+00:00",
      "updated-at": "2020-01-01T00:00:00+00:00",
      "deleted-at": null
    },
    "relationships": {
      "team": {
        "data": {
          "type": "teams",
          "id": "97iQjGNFLTZ5oxfYTKinwo"
        }
      },
      "membership": {
        "data": {
          "type": "memberships",
          "id": "6jVhCt5kE2p6e7B7SX9CGe"
        }
      },
      "created-by": {
        "data": {
          "type": "memberships",
          "id": "C7xWERND6yBTpJJVHACzVf"
        }
      },
      "updated-by": {
        "data": {
          "type": "memberships",
          "id": "C7xWERND6yBTpJJVHACzVf"
        }
      },
      "deleted-by": {
        "data": null
      }
    }
  }
}

Delete Team Member
DELETE`/teams/members/`

Sets the is-archived field’s value to true. Note: The actual instance is not deleted.

Note: Only account admins can delete team members.

Example URI

DELETE https://api.omnigage.io/api/v1/teams/members/

Response 204

Developer Resources ¶

Hook Collection ¶

This resource manages the retrieval of hook collections and the creation of hook instances.

Note: Hooks are only available to account admins.

Retrieve Hooks
GET`/hooks{?include,filter,sort,page}`

Retrieve a collection of hooks.

Example URI

GET https://api.omnigage.io/api/v1/hooks?include=&filter=1&sort=created-at&page=10

URI Parameters

HideShow

include: string (optional)
Include one ore more related relationships using comma separated name.
sort: string (optional) Example: created-at
Sort on one or more fields using comma separated values.
filter: string (optional) Example: 1
Filter on one or more fields using comma separated values filter[field]=1,2.
page: string (optional) Example: 10
Use page[limit]=10 to reduce the number of instances returned. Use ?page[offset]=10 to skip this many instances.

Response 200

HideShow

Body

{
  "links": {
    "self": "/hooks",
    "next": "/hooks?page[offset]=10",
    "last": "/hooks?page[offset]=100"
  },
  "meta": {
    "total": 110,
    "resources": [
      "activities",
      "caller-ids",
      "caller-ids-collaborators",
      "calls",
      "cia-calltrackers",
      "cia-calltrackers-phone-numbers",
      "contacts",
      "contacts-addresses",
      "contacts-collaborators",
      "contacts-emails",
      "contacts-notes",
      "contacts-phones",
      "emails",
      "email-domains",
      "email-domain-dkims",
      "email-ids",
      "email-ids-collaborators",
      "email-messages",
      "email-templates",
      "email-templates-collaborators",
      "engagements",
      "engagements-collaborators",
      "envelopes",
      "export-contacts",
      "import-contacts",
      "invites",
      "lists",
      "lists-items",
      "lists-collaborators",
      "triggers",
      "pages",
      "pages-collaborators",
      "phone-numbers",
      "phone-numbers-collaborators",
      "posts",
      "reviews",
      "reviews-comments",
      "subscriptions",
      "texts",
      "text-messages",
      "text-templates",
      "text-templates-collaborators",
      "voice-messages",
      "voice-templates",
      "voice-templates-collaborators"
    ]
  },
  "data": [
    {
      "id": "C8pd8zmNeCCydUAaXXaQZ4",
      "type": "hooks",
      "attributes": {
        "label": "Call, text and email tracking",
        "url": "https://example.com/webhooks",
        "content-type": "json",
        "secret": "******************oQDh",
        "retry-attempts": 0,
        "is-active": true,
        "is-archived": false,
        "resources": [
          "calls",
          "emails",
          "texts"
        ],
        "created-at": "2020-01-01T00:00:00+00:00",
        "updated-at": "2020-01-01T00:00:00+00:00"
      },
      "relationships": {
        "created-by": {
          "data": {
            "type": "memberships",
            "id": "yxLyyftrAUNWu4qhvefnrf"
          }
        },
        "updated-by": {
          "data": {
            "type": "memberships",
            "id": "yxLyyftrAUNWu4qhvefnrf"
          }
        }
      }
    }
  ]
}

Create Hook
POST`/hooks`

Create a new hook instance.

Example URI

POST https://api.omnigage.io/api/v1/hooks

Request

HideShow

Body

{
  "data": {
    "type": "hooks",
    "attributes": {
      "label": "Call, text and email tracking",
      "url": "https://example.com/webhooks",
      "secret": "Z9U7pEOeJfMksp0gDHIoQDh",
      "resources": [
        "calls",
        "emails",
        "texts"
      ]
    }
  }
}

Response 201

HideShow

Body

{
  "data": {
    "id": "C8pd8zmNeCCydUAaXXaQZ4",
    "type": "hooks",
    "attributes": {
      "label": "Call, text and email tracking",
      "url": "https://example.com/webhooks",
      "content-type": "json",
      "secret": "******************oQDh",
      "retry-attempts": 0,
      "is-active": true,
      "is-archived": false,
      "resources": [
        "calls",
        "emails",
        "texts"
      ],
      "created-at": "2020-01-01T00:00:00+00:00",
      "updated-at": "2020-01-01T00:00:00+00:00"
    },
    "relationships": {
      "created-by": {
        "data": {
          "type": "memberships",
          "id": "yxLyyftrAUNWu4qhvefnrf"
        }
      },
      "updated-by": {
        "data": {
          "type": "memberships",
          "id": "yxLyyftrAUNWu4qhvefnrf"
        }
      }
    }
  }
}

Hook ¶

This resource manages updating, retrieving and deleting a specified hook instance.

Retrieve Hook
GET`/hooks/`

Retrieve an existing hook instance.

Example URI

GET https://api.omnigage.io/api/v1/hooks/

Response 200

HideShow

Body

{
  "data": {
    "id": "C8pd8zmNeCCydUAaXXaQZ4",
    "type": "hooks",
    "attributes": {
      "label": "Call, text and email tracking",
      "url": "https://example.com/webhooks",
      "content-type": "json",
      "secret": "******************oQDh",
      "retry-attempts": 0,
      "is-active": true,
      "is-archived": false,
      "resources": [
        "calls",
        "emails",
        "texts"
      ],
      "created-at": "2020-01-01T00:00:00+00:00",
      "updated-at": "2020-01-01T00:00:00+00:00"
    },
    "relationships": {
      "created-by": {
        "data": {
          "type": "memberships",
          "id": "yxLyyftrAUNWu4qhvefnrf"
        }
      },
      "updated-by": {
        "data": {
          "type": "memberships",
          "id": "yxLyyftrAUNWu4qhvefnrf"
        }
      }
    }
  }
}

Update Hook
PATCH`/hooks/`

Update an existing hook instance.

Example URI

PATCH https://api.omnigage.io/api/v1/hooks/

Request

HideShow

Body

{
  "data": {
    "id": "C8pd8zmNeCCydUAaXXaQZ4",
    "type": "hooks",
    "attributes": {
      "label": "Call, text and email tracking",
      "url": "https://example.com/webhooks",
      "content-type": "json",
      "secret": "******************oQDh",
      "retry-attempts": 0,
      "is-active": true,
      "is-archived": false,
      "resources": [
        "calls",
        "emails",
        "texts"
      ],
      "created-at": "2020-01-01T00:00:00+00:00",
      "updated-at": "2020-01-01T00:00:00+00:00"
    },
    "relationships": {
      "created-by": {
        "data": {
          "type": "memberships",
          "id": "yxLyyftrAUNWu4qhvefnrf"
        }
      },
      "updated-by": {
        "data": {
          "type": "memberships",
          "id": "yxLyyftrAUNWu4qhvefnrf"
        }
      }
    }
  }
}

Response 202

HideShow

Body

{
  "data": {
    "id": "C8pd8zmNeCCydUAaXXaQZ4",
    "type": "hooks",
    "attributes": {
      "label": "Call, text and email tracking",
      "url": "https://example.com/webhooks",
      "content-type": "json",
      "secret": "******************oQDh",
      "retry-attempts": 0,
      "is-active": true,
      "is-archived": false,
      "resources": [
        "calls",
        "emails",
        "texts"
      ],
      "created-at": "2020-01-01T00:00:00+00:00",
      "updated-at": "2020-01-01T00:00:00+00:00"
    },
    "relationships": {
      "created-by": {
        "data": {
          "type": "memberships",
          "id": "yxLyyftrAUNWu4qhvefnrf"
        }
      },
      "updated-by": {
        "data": {
          "type": "memberships",
          "id": "yxLyyftrAUNWu4qhvefnrf"
        }
      }
    }
  }
}

Delete Hook
DELETE`/hooks/`

Sets the is-archived field’s value to true. The hook will no longer be active.

Example URI

DELETE https://api.omnigage.io/api/v1/hooks/

Response 204

Delivery Collection ¶

This resource manages the retrieval of delivery collections.

Note: Deliveries are only available to account admins.

Retrieve Deliveries
GET`/deliveries{?include,sort,filter,page}`

Retrieve a collection of deliveries.

Example URI

GET https://api.omnigage.io/api/v1/deliveries?include=&sort=created-at&filter=1&page=10

URI Parameters

HideShow

include: string (optional)
Include one ore more related relationships using comma separated name.
sort: string (optional) Example: created-at
Sort on one or more fields using comma separated values.
filter: string (optional) Example: 1
Filter on one or more fields using comma separated values filter[field]=1,2.
page: string (optional) Example: 10
Use page[limit]=10 to reduce the number of instances returned. Use ?page[offset]=10 to skip this many instances.

Response 200

HideShow

Body

{
  "links": {
    "self": "/deliveries",
    "next": "/deliveries?page[offset]=10",
    "last": "/deliveries?page[offset]=100"
  },
  "meta": {
    "total": 1
  },
  "data": [
    {
      "id": "TbTvtm4jBPbBBUxQNuLjfr",
      "type": "deliveries",
      "attributes": {
        "status": "success",
        "response-code": 200,
        "response-time": 762,
        "retry-attempts": null,
        "created-at": "2020-01-01T00:00:00+00:00",
        "updated-at": "2020-01-01T00:00:00+00:00"
      },
      "relationships": {
        "updated-by": {
          "data": {
            "type": "memberships",
            "id": "c8sh5y9hdSMS6zVnrvf53T"
          }
        },
        "hook": {
          "data": {
            "type": "hooks",
            "id": "C8pd8zmNeCCydUAaXXaQZ4"
          }
        }
      }
    }
  ]
}

Delivery ¶

This resource manages retrieving a specified delivery instance along with manually requesting to redeliver.

Retrieve Delivery
GET`/deliveries/`

Retrieve an existing delivery instance.

Example URI

GET https://api.omnigage.io/api/v1/deliveries/

Response 200

HideShow

Body

{
  "data": {
    "id": "TbTvtm4jBPbBBUxQNuLjfr",
    "type": "deliveries",
    "attributes": {
      "status": "success",
      "retry-attempts": null,
      "request-headers": {
        "User-Agent": "Omnigage-Hook",
        "X-Omnigage-Delivery-ID": "TbTvtm4jBPbBBUxQNuLjfr",
        "X-Omnigage-Account-ID": "oECYutQ8Qqb42WD4FMF6hX",
        "X-Hub-Signature": "sha1=fbdf724054bd1c829369097adb6950817e7f1587"
      },
      "request-body": {
        "data": {
          "id": "BojTqHDXSK7KcLCn5cZcc8",
          "type": "calls",
          "attributes": {
            "from": "+18775550100",
            "to": "+15197566220",
            "status": "in-progress",
            "direction": "outbound",
            "duration": 1,
            "kind": "native",
            "started-at": "2020-01-01T00:00:00+00:00",
            "finished-at": null,
            "created-at": "2020-01-01T00:00:00+00:00",
            "updated-at": "2020-01-01T00:00:00+00:00"
          },
          "relationships": {
            "created-by": {
              "data": {
                "type": "users",
                "id": "dQ6e35CE53y8a2n5hjAaRz"
              }
            },
            "updated-by": {
              "data": {
                "type": "users",
                "id": "dQ6e35CE53y8a2n5hjAaRz"
              }
            },
            "parent-call": {
              "data": {
                "type": "calls",
                "id": "KXq9WyvGHx8ueyWLooLkMP"
              }
            },
            "caller-id": {
              "data": {
                "type": "caller-ids",
                "id": "DECRngt4uXqsvCgbyM7d7p"
              }
            },
            "phone-number": {
              "data": null
            },
            "envelope": {
              "data": {
                "type": "envelopes",
                "id": "uLjLNq6tkPEhTuCUQsuipq"
              }
            },
            "result": {
              "data": {
                "type": "call-results",
                "id": "SYv626tNVtprEQmMJDdr6B"
              }
            },
            "contact": {
              "data": {
                "type": "contacts",
                "id": "KVLK7zmqDZxCtVYAb4mAqR"
              }
            },
            "recorded-file": {
              "data": null
            }
          }
        }
      },
      "response-code": 200,
      "response-headers": {
        "Connection": "keep-alive",
        "Content-Length": "0",
        "Date": "Mon, 07 May 2020 20:46:26 GMT",
        "Server": "nginx",
        "Strict-Transport-Security": "max-age=15724800"
      },
      "response-body": "",
      "response-time": 762,
      "created-at": "2020-01-01T00:00:00+00:00",
      "updated-at": "2020-01-01T00:00:00+00:00"
    },
    "relationships": {
      "updated-by": {
        "data": {
          "type": "memberships",
          "id": "c8sh5y9hdSMS6zVnrvf53T"
        }
      },
      "hook": {
        "data": {
          "type": "hooks",
          "id": "C8pd8zmNeCCydUAaXXaQZ4"
        }
      }
    }
  }
}

Update Delivery
PATCH`/deliveries/`

Update an existing delivery instance.

Example URI

PATCH https://api.omnigage.io/api/v1/deliveries/

Request

HideShow

Body

{
  "data": {
    "id": "TbTvtm4jBPbBBUxQNuLjfr",
    "type": "deliveries",
    "attributes": {
      "status": "success",
      "retry-attempts": null,
      "request-headers": {
        "User-Agent": "Omnigage-Hook",
        "X-Omnigage-Delivery-ID": "TbTvtm4jBPbBBUxQNuLjfr",
        "X-Omnigage-Account-ID": "oECYutQ8Qqb42WD4FMF6hX",
        "X-Hub-Signature": "sha1=fbdf724054bd1c829369097adb6950817e7f1587"
      },
      "request-body": {
        "data": {
          "id": "BojTqHDXSK7KcLCn5cZcc8",
          "type": "calls",
          "attributes": {
            "from": "+18775550100",
            "to": "+15197566220",
            "status": "in-progress",
            "direction": "outbound",
            "duration": 1,
            "kind": "native",
            "started-at": "2020-01-01T00:00:00+00:00",
            "finished-at": null,
            "created-at": "2020-01-01T00:00:00+00:00",
            "updated-at": "2020-01-01T00:00:00+00:00"
          },
          "relationships": {
            "created-by": {
              "data": {
                "type": "users",
                "id": "dQ6e35CE53y8a2n5hjAaRz"
              }
            },
            "updated-by": {
              "data": {
                "type": "users",
                "id": "dQ6e35CE53y8a2n5hjAaRz"
              }
            },
            "parent-call": {
              "data": {
                "type": "calls",
                "id": "KXq9WyvGHx8ueyWLooLkMP"
              }
            },
            "caller-id": {
              "data": {
                "type": "caller-ids",
                "id": "DECRngt4uXqsvCgbyM7d7p"
              }
            },
            "phone-number": {
              "data": null
            },
            "envelope": {
              "data": {
                "type": "envelopes",
                "id": "uLjLNq6tkPEhTuCUQsuipq"
              }
            },
            "result": {
              "data": {
                "type": "call-results",
                "id": "SYv626tNVtprEQmMJDdr6B"
              }
            },
            "contact": {
              "data": {
                "type": "contacts",
                "id": "KVLK7zmqDZxCtVYAb4mAqR"
              }
            },
            "recorded-file": {
              "data": null
            }
          }
        }
      },
      "response-code": 200,
      "response-headers": {
        "Connection": "keep-alive",
        "Content-Length": "0",
        "Date": "Mon, 07 May 2020 20:46:26 GMT",
        "Server": "nginx",
        "Strict-Transport-Security": "max-age=15724800"
      },
      "response-body": "",
      "response-time": 762,
      "created-at": "2020-01-01T00:00:00+00:00",
      "updated-at": "2020-01-01T00:00:00+00:00"
    },
    "relationships": {
      "updated-by": {
        "data": {
          "type": "memberships",
          "id": "c8sh5y9hdSMS6zVnrvf53T"
        }
      },
      "hook": {
        "data": {
          "type": "hooks",
          "id": "C8pd8zmNeCCydUAaXXaQZ4"
        }
      }
    }
  }
}

Response 202

HideShow

Body

{
  "data": {
    "id": "TbTvtm4jBPbBBUxQNuLjfr",
    "type": "deliveries",
    "attributes": {
      "status": "success",
      "retry-attempts": null,
      "request-headers": {
        "User-Agent": "Omnigage-Hook",
        "X-Omnigage-Delivery-ID": "TbTvtm4jBPbBBUxQNuLjfr",
        "X-Omnigage-Account-ID": "oECYutQ8Qqb42WD4FMF6hX",
        "X-Hub-Signature": "sha1=fbdf724054bd1c829369097adb6950817e7f1587"
      },
      "request-body": {
        "data": {
          "id": "BojTqHDXSK7KcLCn5cZcc8",
          "type": "calls",
          "attributes": {
            "from": "+18775550100",
            "to": "+15197566220",
            "status": "in-progress",
            "direction": "outbound",
            "duration": 1,
            "kind": "native",
            "started-at": "2020-01-01T00:00:00+00:00",
            "finished-at": null,
            "created-at": "2020-01-01T00:00:00+00:00",
            "updated-at": "2020-01-01T00:00:00+00:00"
          },
          "relationships": {
            "created-by": {
              "data": {
                "type": "users",
                "id": "dQ6e35CE53y8a2n5hjAaRz"
              }
            },
            "updated-by": {
              "data": {
                "type": "users",
                "id": "dQ6e35CE53y8a2n5hjAaRz"
              }
            },
            "parent-call": {
              "data": {
                "type": "calls",
                "id": "KXq9WyvGHx8ueyWLooLkMP"
              }
            },
            "caller-id": {
              "data": {
                "type": "caller-ids",
                "id": "DECRngt4uXqsvCgbyM7d7p"
              }
            },
            "phone-number": {
              "data": null
            },
            "envelope": {
              "data": {
                "type": "envelopes",
                "id": "uLjLNq6tkPEhTuCUQsuipq"
              }
            },
            "result": {
              "data": {
                "type": "call-results",
                "id": "SYv626tNVtprEQmMJDdr6B"
              }
            },
            "contact": {
              "data": {
                "type": "contacts",
                "id": "KVLK7zmqDZxCtVYAb4mAqR"
              }
            },
            "recorded-file": {
              "data": null
            }
          }
        }
      },
      "response-code": 200,
      "response-headers": {
        "Connection": "keep-alive",
        "Content-Length": "0",
        "Date": "Mon, 07 May 2020 20:46:26 GMT",
        "Server": "nginx",
        "Strict-Transport-Security": "max-age=15724800"
      },
      "response-body": "",
      "response-time": 762,
      "created-at": "2020-01-01T00:00:00+00:00",
      "updated-at": "2020-01-01T00:00:00+00:00"
    },
    "relationships": {
      "updated-by": {
        "data": {
          "type": "memberships",
          "id": "c8sh5y9hdSMS6zVnrvf53T"
        }
      },
      "hook": {
        "data": {
          "type": "hooks",
          "id": "C8pd8zmNeCCydUAaXXaQZ4"
        }
      }
    }
  }
}

Terminal Resources ¶

Terminal Collection ¶

This resource manages the retrieval of terminal collections and the creation of terminal instances.

Note: This resource is only available to account admins.

Retrieve Terminals
GET`/terminals{?include,filter,sort,page}`

Retrieve a collection of terminals.

Example URI

GET https://api.omnigage.io/api/v1/terminals?include=&filter=1&sort=created-at&page=10

URI Parameters

HideShow

include: string (optional)
Include one ore more related relationships using comma separated name.
sort: string (optional) Example: created-at
Sort on one or more fields using comma separated values.
filter: string (optional) Example: 1
Filter on one or more fields using comma separated values filter[field]=1,2.
page: string (optional) Example: 10
Use page[limit]=10 to reduce the number of instances returned. Use ?page[offset]=10 to skip this many instances.

Response 200

HideShow

Body

{
  "links": {
    "self": "/terminals",
    "next": "/terminals?page[offset]=10",
    "last": "/terminals?page[offset]=100"
  },
  "meta": {
    "total": 110
  },
  "data": [
    {
      "id": "C8pd8zmNeCCydUAaXXaQZ4",
      "type": "terminals",
      "attributes": {
        "label": "CTI Terminal",
        "embed": "<script>!function(d,o){window.Omnigage=o;o.terminal=o.terminal||{};var t=o.terminal;t.readyHandlers=[];t.ready=function(h){this.readyHandlers.push(h)};t.config={terminalId:\"C8pd8zmNeCCydUAaXXaQZ4\"};var s=d.getElementsByTagName(\"script\")[0],e=d.createElement(\"script\");e.type=\"text/javascript\";e.async=True;e.src=\"https://embed.omnigage.io/\";s.parentNode.insertBefore(c,r)}(document,window.Omnigage||{});</script>",
        "is-archived": false,
        "created-at": "2020-01-01T00:00:00+00:00",
        "updated-at": "2020-01-01T00:00:00+00:00"
      },
      "relationships": {
        "created-by": {
          "data": {
            "type": "memberships",
            "id": "yxLyyftrAUNWu4qhvefnrf"
          }
        },
        "updated-by": {
          "data": {
            "type": "memberships",
            "id": "yxLyyftrAUNWu4qhvefnrf"
          }
        }
      }
    }
  ]
}

Create Terminal
POST`/terminals`

Create a new terminal instance.

The instance’s ID can be used with the header X-Terminal-ID. When using this header, the account key/id headers do not need to be set. The header will check that the terminal is in an active state. Additionally, when using this header, only the following resources are permitted:

activities
caller-ids
caller-ids-collaborators
calls
call-results
contacts
contacts-addresses
contacts-collaborators
contacts-emails
contacts-notes
contacts-phones
countries
emails
email-ids
email-ids-collaborators
email-messages
email-results
email-templates
email-templates-revisions
email-templates-collaborators
engagements
engagements-collaborators
envelopes
files
lists
lists-items
lists-collaborators
member
member-statuses
pictures
triggers
phone-numbers
phone-numbers-collaborators
result-metrics
reviews
reviews-comments
settings - Read-only
texts
text-messages
text-results
text-templates
text-templates-revisions
text-templates-collaborators
timezones
uploads
users
voice-messages
voice-templates
voice-templates-revisions
voice-templates-collaborators

Example URI

POST https://api.omnigage.io/api/v1/terminals

Request

HideShow

Body

{
  "data": {
    "type": "terminals",
    "attributes": {
      "label": "CTI Terminal"
    }
  }
}

Response 201

HideShow

Body

{
  "data": {
    "id": "C8pd8zmNeCCydUAaXXaQZ4",
    "type": "terminals",
    "attributes": {
      "label": "CTI Terminal",
      "embed": "<script>!function(d,o){window.Omnigage=o;o.terminal=o.terminal||{};var t=o.terminal;t.readyHandlers=[];t.ready=function(h){this.readyHandlers.push(h)};t.config={terminalId:\"C8pd8zmNeCCydUAaXXaQZ4\"};var s=d.getElementsByTagName(\"script\")[0],e=d.createElement(\"script\");e.type=\"text/javascript\";e.async=True;e.src=\"https://embed.omnigage.io/\";s.parentNode.insertBefore(c,r)}(document,window.Omnigage||{});</script>",
      "is-archived": false,
      "created-at": "2020-01-01T00:00:00+00:00",
      "updated-at": "2020-01-01T00:00:00+00:00"
    },
    "relationships": {
      "created-by": {
        "data": {
          "type": "memberships",
          "id": "yxLyyftrAUNWu4qhvefnrf"
        }
      },
      "updated-by": {
        "data": {
          "type": "memberships",
          "id": "yxLyyftrAUNWu4qhvefnrf"
        }
      }
    }
  }
}

Terminal ¶

This resource manages updating, retrieving and deleting a specified terminal instance.

Retrieve Terminal
GET`/terminals/`

Retrieve an existing terminal instance.

Example URI

GET https://api.omnigage.io/api/v1/terminals/

Response 200

HideShow

Body

{
  "data": {
    "id": "C8pd8zmNeCCydUAaXXaQZ4",
    "type": "terminals",
    "attributes": {
      "label": "CTI Terminal",
      "embed": "<script>!function(d,o){window.Omnigage=o;o.terminal=o.terminal||{};var t=o.terminal;t.readyHandlers=[];t.ready=function(h){this.readyHandlers.push(h)};t.config={terminalId:\"C8pd8zmNeCCydUAaXXaQZ4\"};var s=d.getElementsByTagName(\"script\")[0],e=d.createElement(\"script\");e.type=\"text/javascript\";e.async=True;e.src=\"https://embed.omnigage.io/\";s.parentNode.insertBefore(c,r)}(document,window.Omnigage||{});</script>",
      "is-archived": false,
      "created-at": "2020-01-01T00:00:00+00:00",
      "updated-at": "2020-01-01T00:00:00+00:00"
    },
    "relationships": {
      "created-by": {
        "data": {
          "type": "memberships",
          "id": "yxLyyftrAUNWu4qhvefnrf"
        }
      },
      "updated-by": {
        "data": {
          "type": "memberships",
          "id": "yxLyyftrAUNWu4qhvefnrf"
        }
      }
    }
  }
}

Update Terminal
PATCH`/terminals/`

Update an existing terminal instance.

Example URI

PATCH https://api.omnigage.io/api/v1/terminals/

Request

HideShow

Body

{
  "data": {
    "id": "C8pd8zmNeCCydUAaXXaQZ4",
    "type": "terminals",
    "attributes": {
      "label": "CTI Terminal",
      "embed": "<script>!function(d,o){window.Omnigage=o;o.terminal=o.terminal||{};var t=o.terminal;t.readyHandlers=[];t.ready=function(h){this.readyHandlers.push(h)};t.config={terminalId:\"C8pd8zmNeCCydUAaXXaQZ4\"};var s=d.getElementsByTagName(\"script\")[0],e=d.createElement(\"script\");e.type=\"text/javascript\";e.async=True;e.src=\"https://embed.omnigage.io/\";s.parentNode.insertBefore(c,r)}(document,window.Omnigage||{});</script>",
      "is-archived": false,
      "created-at": "2020-01-01T00:00:00+00:00",
      "updated-at": "2020-01-01T00:00:00+00:00"
    },
    "relationships": {
      "created-by": {
        "data": {
          "type": "memberships",
          "id": "yxLyyftrAUNWu4qhvefnrf"
        }
      },
      "updated-by": {
        "data": {
          "type": "memberships",
          "id": "yxLyyftrAUNWu4qhvefnrf"
        }
      }
    }
  }
}

Response 202

HideShow

Body

{
  "data": {
    "id": "C8pd8zmNeCCydUAaXXaQZ4",
    "type": "terminals",
    "attributes": {
      "label": "CTI Terminal",
      "embed": "<script>!function(d,o){window.Omnigage=o;o.terminal=o.terminal||{};var t=o.terminal;t.readyHandlers=[];t.ready=function(h){this.readyHandlers.push(h)};t.config={terminalId:\"C8pd8zmNeCCydUAaXXaQZ4\"};var s=d.getElementsByTagName(\"script\")[0],e=d.createElement(\"script\");e.type=\"text/javascript\";e.async=True;e.src=\"https://embed.omnigage.io/\";s.parentNode.insertBefore(c,r)}(document,window.Omnigage||{});</script>",
      "is-archived": false,
      "created-at": "2020-01-01T00:00:00+00:00",
      "updated-at": "2020-01-01T00:00:00+00:00"
    },
    "relationships": {
      "created-by": {
        "data": {
          "type": "memberships",
          "id": "yxLyyftrAUNWu4qhvefnrf"
        }
      },
      "updated-by": {
        "data": {
          "type": "memberships",
          "id": "yxLyyftrAUNWu4qhvefnrf"
        }
      }
    }
  }
}

Delete Terminal
DELETE`/terminals/`

Sets the is-archived field’s value to true.

Example URI

DELETE https://api.omnigage.io/api/v1/terminals/

Response 204

Reporting Resources ¶

Membership Status Collection ¶

This resource retrieves the record of membership statuses changing over time.

Retrieve Membership Status
GET`/logs/membership-statuses{?include,filter,sort,page}`

Retrieve a collection of status.

Example URI

GET https://api.omnigage.io/api/v1/logs/membership-statuses?include=&filter=1&sort=created-at&page=10

URI Parameters

HideShow

include: string (optional)
Include one ore more related relationships using comma separated name.
sort: string (optional) Example: created-at
Sort on one or more fields using comma separated values.
filter: string (optional) Example: 1
Filter on one or more fields using comma separated values filter[field]=1,2.
page: string (optional) Example: 10
Use page[limit]=10 to reduce the number of instances returned. Use ?page[offset]=10 to skip this many instances.

Response 200

HideShow

Body

{
  "links": {
    "self": "/logs/membership-statuses",
    "next": "/logs/membership-statuses",
    "last": "/logs/membership-statuses"
  },
  "meta": {
    "total": 11
  },
  "data": [
    {
      "id": "THWfEfDcwkgLH674YSGVxq",
      "type": "logs-membership-statuses",
      "attributes": {
        "duration": 67,
        "started-at": "2020-01-01T00:00:00+00:00",
        "finished-at": "2020-01-01T00:00:00+00:00"
      },
      "relationships": {
        "membership": {
          "data": {
            "type": "memberships",
            "id": "C7xWERND6yBTpJJVHACzVf"
          }
        },
        "member-status": {
          "data": {
            "type": "member-status",
            "id": "nW9bBBssnEnitvHihJtRvF"
          }
        }
      }
    }
  ]
}

Membership Status ¶

This resource manages retrieving a specified status instance.

Retrieve Membership Status
GET`/logs/membership-statuses/`

Retrieve an existing log membership status instance.

Example URI

GET https://api.omnigage.io/api/v1/logs/membership-statuses/

Response 200

HideShow

Body

{
  "data": {
    "id": "THWfEfDcwkgLH674YSGVxq",
    "type": "logs-membership-statuses",
    "attributes": {
      "duration": 67,
      "started-at": "2020-01-01T00:00:00+00:00",
      "finished-at": "2020-01-01T00:00:00+00:00"
    },
    "relationships": {
      "membership": {
        "data": {
          "type": "memberships",
          "id": "C7xWERND6yBTpJJVHACzVf"
        }
      },
      "member-status": {
        "data": {
          "type": "member-status",
          "id": "nW9bBBssnEnitvHihJtRvF"
        }
      }
    }
  }
}

Billing Resources ¶

Invoice Collection ¶

This resource manages the retrieval of invoice collections.

Note: This resource is only accessible by account admins.

Retrieve Invoices
GET`/invoices{?include,filter,sort,page}`

Retrieve a collection of invoices.

Example URI

GET https://api.omnigage.io/api/v1/invoices?include=&filter=1&sort=created-at&page=10

URI Parameters

HideShow

include: string (optional)
Include one ore more related relationships using comma separated name.
sort: string (optional) Example: created-at
Sort on one or more fields using comma separated values.
filter: string (optional) Example: 1
Filter on one or more fields using comma separated values filter[field]=1,2.
page: string (optional) Example: 10
Use page[limit]=10 to reduce the number of instances returned. Use ?page[offset]=10 to skip this many instances.

Response 200

HideShow

Body

{
  "links": {
    "self": "/invoices",
    "next": "/invoices?page[offset]=10",
    "last": "/invoices?page[offset]=100"
  },
  "meta": {
    "total": 110
  },
  "data": [
    {
      "id": "c8sh5y9hdSMS6zVnrvf53T",
      "type": "invoices",
      "attributes": {
        "number": "83232F9-0001",
        "is-paid": true,
        "amount-due": 250,
        "amount-paid": 250,
        "total": 250,
        "subtotal": 250,
        "due-at": "2020-05-01T00:00:00+00:00",
        "period-start": "2020-04-01T00:00:00+00:00",
        "period-end": "2020-04-30T00:00:00+00:00",
        "created-at": "2020-01-01T00:00:00+00:00",
        "updated-at": "2020-01-01T00:00:00+00:00"
      },
      "relationships": {
        "file": {
          "data": {
            "type": "files",
            "id": "Ghw2cs3sh36LVNMi9ScjBT"
          }
        },
        "plan": {
          "data": null
        },
        "payment-method": {
          "data": null
        },
        "created-by": {
          "data": null
        },
        "updated-by": {
          "data": {
            "type": "memberships",
            "id": "wpsWLdLt9nscn2jbTD3uxe"
          }
        }
      }
    }
  ]
}

Invoice ¶

This resource retrieves a specified invoice instance.

Retrieve Invoice
GET`/invoices/`

Retrieve an existing invoice instance.

Example URI

GET https://api.omnigage.io/api/v1/invoices/

Response 200

HideShow

Body

{
  "data": {
    "id": "c8sh5y9hdSMS6zVnrvf53T",
    "type": "invoices",
    "attributes": {
      "number": "83232F9-0001",
      "is-paid": true,
      "amount-due": 250,
      "amount-paid": 250,
      "total": 250,
      "subtotal": 250,
      "due-at": "2020-05-01T00:00:00+00:00",
      "period-start": "2020-04-01T00:00:00+00:00",
      "period-end": "2020-04-30T00:00:00+00:00",
      "created-at": "2020-01-01T00:00:00+00:00",
      "updated-at": "2020-01-01T00:00:00+00:00"
    },
    "relationships": {
      "file": {
        "data": {
          "type": "files",
          "id": "Ghw2cs3sh36LVNMi9ScjBT"
        }
      },
      "plan": {
        "data": null
      },
      "payment-method": {
        "data": null
      },
      "created-by": {
        "data": null
      },
      "updated-by": {
        "data": {
          "type": "memberships",
          "id": "wpsWLdLt9nscn2jbTD3uxe"
        }
      }
    }
  }
}

Update Invoice
PATCH`/invoices/`

Supply payment-methods instance when invoice is-paid is false.

Example URI

PATCH https://api.omnigage.io/api/v1/invoices/

Request

HideShow

Body

{
  "data": {
    "id": "c8sh5y9hdSMS6zVnrvf53T",
    "type": "invoices",
    "attributes": {
      "number": "83232F9-0001",
      "is-paid": true,
      "amount-due": 250,
      "amount-paid": 250,
      "total": 250,
      "subtotal": 250,
      "due-at": "2020-05-01T00:00:00+00:00",
      "period-start": "2020-04-01T00:00:00+00:00",
      "period-end": "2020-04-30T00:00:00+00:00",
      "created-at": "2020-01-01T00:00:00+00:00",
      "updated-at": "2020-01-01T00:00:00+00:00"
    },
    "relationships": {
      "file": {
        "data": {
          "type": "files",
          "id": "Ghw2cs3sh36LVNMi9ScjBT"
        }
      },
      "plan": {
        "data": null
      },
      "payment-method": {
        "data": null
      },
      "created-by": {
        "data": null
      },
      "updated-by": {
        "data": {
          "type": "memberships",
          "id": "wpsWLdLt9nscn2jbTD3uxe"
        }
      }
    }
  }
}

Response 202

HideShow

Body

{
  "data": {
    "id": "c8sh5y9hdSMS6zVnrvf53T",
    "type": "invoices",
    "attributes": {
      "number": "83232F9-0001",
      "is-paid": true,
      "amount-due": 250,
      "amount-paid": 250,
      "total": 250,
      "subtotal": 250,
      "due-at": "2020-05-01T00:00:00+00:00",
      "period-start": "2020-04-01T00:00:00+00:00",
      "period-end": "2020-04-30T00:00:00+00:00",
      "created-at": "2020-01-01T00:00:00+00:00",
      "updated-at": "2020-01-01T00:00:00+00:00"
    },
    "relationships": {
      "file": {
        "data": {
          "type": "files",
          "id": "Ghw2cs3sh36LVNMi9ScjBT"
        }
      },
      "plan": {
        "data": null
      },
      "payment-method": {
        "data": null
      },
      "created-by": {
        "data": null
      },
      "updated-by": {
        "data": {
          "type": "memberships",
          "id": "wpsWLdLt9nscn2jbTD3uxe"
        }
      }
    }
  }
}

Payment Method Collection ¶

This resource manages the retrieval and creation of payment method instances.

Note: This resource is only accessible by account admins.

Retrieve Payment Methods
GET`/payment-methods{?include,filter,sort,page}`

Retrieve a collection of payment methods.

Example URI

GET https://api.omnigage.io/api/v1/payment-methods?include=&filter=1&sort=created-at&page=10

URI Parameters

HideShow

include: string (optional)
Include one ore more related relationships using comma separated name.
sort: string (optional) Example: created-at
Sort on one or more fields using comma separated values.
filter: string (optional) Example: 1
Filter on one or more fields using comma separated values filter[field]=1,2.
page: string (optional) Example: 10
Use page[limit]=10 to reduce the number of instances returned. Use ?page[offset]=10 to skip this many instances.

Response 200

HideShow

Body

{
    "links": {
        "self": "/payment-methods",
        "next": "/payment-methods?page[offset]=10",
        "last": "/payment-methods?page[offset]=100"
    },
    "meta": {
        "total": 110
    },
    "data": [{
        "id": "c8sh5y9hdSMS6zVnrvf53T",
        "type": "payment-methods",
        "attributes": {
            "status": "active",
            "kind": "card",
            "card-name": "Alexander Bell",
            "card-last4": "8721",
            "card-expiration-month": 09,
            "card-expiration-year": 2022,
            "card-brand": "amex",
            "card-address-line1": null,
            "card-address-line2": null,
            "card-address-city": null,
            "card-address-state": null,
            "card-address-zip": null,
            "card-address-country": null,
            "service-stripe-token": null,
            "is-archived": false,
            "created-at": "2020-01-01T00:00:00+00:00",
            "updated-at": "2020-01-01T00:00:00+00:00"
        },
        "relationships": {
            "created-by": {
                "data": {"type": "memberships", "id": "wpsWLdLt9nscn2jbTD3uxe"}
            },
            "updated-by": {
                "data": {"type": "memberships", "id": "wpsWLdLt9nscn2jbTD3uxe"}
            }
        }
    }]
}

Create Payment Method
POST`/payment-methods`

Create a new payment method instance.

Example URI

POST https://api.omnigage.io/api/v1/payment-methods

Request

HideShow

Body

{
  "data": {
    "type": "payment-methods",
    "attributes": {
      "service-stripe-token": "tok_1DENUYE7JedbIXYy6DGeNv1X"
    }
  }
}

Response 201

HideShow

Body

{
    "data": {
        "id": "c8sh5y9hdSMS6zVnrvf53T",
        "type": "payment-methods",
        "attributes": {
            "status": "active",
            "kind": "card",
            "card-name": "Alexander Bell",
            "card-last4": "8721",
            "card-expiration-month": 09,
            "card-expiration-year": 2022,
            "card-brand": "amex",
            "card-address-line1": null,
            "card-address-line2": null,
            "card-address-city": null,
            "card-address-state": null,
            "card-address-zip": null,
            "card-address-country": null,
            "service-stripe-token": null,
            "is-archived": false,
            "created-at": "2020-01-01T00:00:00+00:00",
            "updated-at": "2020-01-01T00:00:00+00:00"
        },
        "relationships": {
            "created-by": {
                "data": {"type": "memberships", "id": "wpsWLdLt9nscn2jbTD3uxe"}
            },
            "updated-by": {
                "data": {"type": "memberships", "id": "wpsWLdLt9nscn2jbTD3uxe"}
            }
        }
    }
}

Payment Method ¶

This resource retrieves a specified payment method instance along with supporting updates.

Retrieve Payment Method
GET`/payment-methods/`

Retrieve an existing payment method instance.

Example URI

GET https://api.omnigage.io/api/v1/payment-methods/

Response 200

HideShow

Body

{
    "data": {
        "id": "c8sh5y9hdSMS6zVnrvf53T",
        "type": "payment-methods",
        "attributes": {
            "status": "active",
            "kind": "card",
            "card-name": "Alexander Bell",
            "card-last4": "8721",
            "card-expiration-month": 09,
            "card-expiration-year": 2022,
            "card-brand": "amex",
            "card-address-line1": null,
            "card-address-line2": null,
            "card-address-city": null,
            "card-address-state": null,
            "card-address-zip": null,
            "card-address-country": null,
            "service-stripe-token": null,
            "is-archived": false,
            "created-at": "2020-01-01T00:00:00+00:00",
            "updated-at": "2020-01-01T00:00:00+00:00"
        },
        "relationships": {
            "created-by": {
                "data": {"type": "memberships", "id": "wpsWLdLt9nscn2jbTD3uxe"}
            },
            "updated-by": {
                "data": {"type": "memberships", "id": "wpsWLdLt9nscn2jbTD3uxe"}
            }
        }
    }
}

Update Payment Method
PATCH`/payment-methods/`

Example URI

PATCH https://api.omnigage.io/api/v1/payment-methods/

Request

HideShow

Body

{
    "data": {
        "id": "c8sh5y9hdSMS6zVnrvf53T",
        "type": "payment-methods",
        "attributes": {
            "status": "active",
            "kind": "card",
            "card-name": "Alexander Bell",
            "card-last4": "8721",
            "card-expiration-month": 09,
            "card-expiration-year": 2022,
            "card-brand": "amex",
            "card-address-line1": null,
            "card-address-line2": null,
            "card-address-city": null,
            "card-address-state": null,
            "card-address-zip": null,
            "card-address-country": null,
            "service-stripe-token": null,
            "is-archived": false,
            "created-at": "2020-01-01T00:00:00+00:00",
            "updated-at": "2020-01-01T00:00:00+00:00"
        },
        "relationships": {
            "created-by": {
                "data": {"type": "memberships", "id": "wpsWLdLt9nscn2jbTD3uxe"}
            },
            "updated-by": {
                "data": {"type": "memberships", "id": "wpsWLdLt9nscn2jbTD3uxe"}
            }
        }
    }
}

Response 202

HideShow

Body

{
    "data": {
        "id": "c8sh5y9hdSMS6zVnrvf53T",
        "type": "payment-methods",
        "attributes": {
            "status": "active",
            "kind": "card",
            "card-name": "Alexander Bell",
            "card-last4": "8721",
            "card-expiration-month": 09,
            "card-expiration-year": 2022,
            "card-brand": "amex",
            "card-address-line1": null,
            "card-address-line2": null,
            "card-address-city": null,
            "card-address-state": null,
            "card-address-zip": null,
            "card-address-country": null,
            "service-stripe-token": null,
            "is-archived": false,
            "created-at": "2020-01-01T00:00:00+00:00",
            "updated-at": "2020-01-01T00:00:00+00:00"
        },
        "relationships": {
            "created-by": {
                "data": {"type": "memberships", "id": "wpsWLdLt9nscn2jbTD3uxe"}
            },
            "updated-by": {
                "data": {"type": "memberships", "id": "wpsWLdLt9nscn2jbTD3uxe"}
            }
        }
    }
}

Delete Payment Method
DELETE`/payment-methods/`

Sets the is-archived field’s value to true. Note: The actual instance is not deleted.

Example URI

DELETE https://api.omnigage.io/api/v1/payment-methods/

Response 204

Plan Collection ¶

This resource manages the retrieval of plan collections.

Note: This resource is accessible by all account memberships.

Retrieve Plans
GET`/plans{?include,filter,sort,page}`

Retrieve a collection of plans.

Example URI

GET https://api.omnigage.io/api/v1/plans?include=&filter=1&sort=created-at&page=10

URI Parameters

HideShow

include: string (optional)
Include one ore more related relationships using comma separated name.
sort: string (optional) Example: created-at
Sort on one or more fields using comma separated values.
filter: string (optional) Example: 1
Filter on one or more fields using comma separated values filter[field]=1,2.
page: string (optional) Example: 10
Use page[limit]=10 to reduce the number of instances returned. Use ?page[offset]=10 to skip this many instances.

Response 200

HideShow

Body

{
  "links": {
    "self": "/plans",
    "next": "/plans?page[offset]=10",
    "last": "/plans?page[offset]=100"
  },
  "meta": {
    "total": 110
  },
  "data": [
    {
      "id": "c8sh5y9hdSMS6zVnrvf53T",
      "type": "plans",
      "attributes": {
        "name": "Enterprise",
        "key": "enterprise",
        "amount": 100,
        "is-enabled-audit-logs": true,
        "is-enabled-collaborators": true,
        "is-enabled-hooks": true,
        "is-enabled-metrics": true,
        "is-enabled-pages": true,
        "is-enabled-reviews": true,
        "is-enabled-sso": true,
        "is-enabled-terminals": true,
        "is-enabled-teams": true,
        "is-enabled-threads": true,
        "is-enabled-tokens": true,
        "is-archived": false,
        "created-at": "2020-01-01T00:00:00+00:00",
        "updated-at": "2020-01-01T00:00:00+00:00"
      }
    }
  ]
}

Plan ¶

This resource retrieves a specified plan instance.

Retrieve Plan
GET`/plans/`

Retrieve an existing plan instance.

Example URI

GET https://api.omnigage.io/api/v1/plans/

Response 200

HideShow

Body

{
  "data": {
    "id": "c8sh5y9hdSMS6zVnrvf53T",
    "type": "plans",
    "attributes": {
      "name": "Enterprise",
      "key": "enterprise",
      "amount": 100,
      "is-enabled-audit-logs": true,
      "is-enabled-collaborators": true,
      "is-enabled-hooks": true,
      "is-enabled-metrics": true,
      "is-enabled-pages": true,
      "is-enabled-reviews": true,
      "is-enabled-sso": true,
      "is-enabled-terminals": true,
      "is-enabled-teams": true,
      "is-enabled-threads": true,
      "is-enabled-tokens": true,
      "is-archived": false,
      "created-at": "2020-01-01T00:00:00+00:00",
      "updated-at": "2020-01-01T00:00:00+00:00"
    }
  }
}

Permissions ¶

The below table defines what resources are available based on the context:

Resource	Account ID/Key	Terminal ID	Is Suspended/Canceled
account	TRUE	Read-only	TRUE
activities	TRUE	TRUE	FALSE
audit-logs	TRUE	FALSE	FALSE
call-results	TRUE	TRUE	FALSE
call-time-metrics	TRUE	TRUE	FALSE
caller-ids	TRUE	TRUE	FALSE
caller-ids-collaborators	TRUE	TRUE	FALSE
calls	TRUE	TRUE	FALSE
cia-calltrackers	TRUE	FALSE	FALSE
cia-calltrackers-phone-numbers	TRUE	FALSE	FALSE
conferences	TRUE	TRUE	FALSE
conferences-collaborators	TRUE	TRUE	FALSE
confirm-email-ids	TRUE	FALSE	FALSE
contacts	TRUE	TRUE	FALSE
contacts-addresses	TRUE	TRUE	FALSE
contacts-collaborators	TRUE	TRUE	FALSE
contacts-emails	TRUE	TRUE	FALSE
contacts-notes	TRUE	TRUE	FALSE
contacts-phones	TRUE	TRUE	FALSE
countries	TRUE	TRUE	TRUE
email-domain-dkims	TRUE	FALSE	FALSE
email-domains	TRUE	FALSE	FALSE
email-ids	TRUE	TRUE	FALSE
email-ids-collaborators	TRUE	TRUE	FALSE
email-messages	TRUE	TRUE	FALSE
email-results	TRUE	TRUE	FALSE
email-templates	TRUE	TRUE	FALSE
email-templates-collaborators	TRUE	TRUE	FALSE
email-templates-revisions	TRUE	TRUE	FALSE
emails	TRUE	TRUE	FALSE
engagements	TRUE	TRUE	FALSE
engagements-collaborators	TRUE	TRUE	FALSE
engagements-reviews	TRUE	TRUE	FALSE
envelopes	TRUE	TRUE	FALSE
export-contacts	TRUE	FALSE	FALSE
files	TRUE	TRUE	FALSE
hooks	TRUE	FALSE	FALSE
hooks-deliveries	TRUE	FALSE	FALSE
import-contacts	TRUE	FALSE	FALSE
import-contacts-preflights	TRUE	FALSE	FALSE
import-contacts-results	TRUE	FALSE	FALSE
import-memberships	TRUE	FALSE	FALSE
import-memberships-results	TRUE	FALSE	FALSE
invoices	TRUE	FALSE	TRUE
lists	TRUE	TRUE	FALSE
lists-collaborators	TRUE	TRUE	FALSE
lists-items	TRUE	TRUE	FALSE
member	TRUE	TRUE	TRUE
member-statuses	TRUE	TRUE	TRUE
memberships	TRUE	Read-only	Read-only
oauth2-revoke	TRUE	TRUE	TRUE
oauth2-tokens	TRUE	TRUE	TRUE
pages	TRUE	FALSE	FALSE
pages-collaborators	TRUE	FALSE	FALSE
pages-revisions	TRUE	FALSE	FALSE
payment-methods	TRUE	FALSE	TRUE
phone-numbers	TRUE	TRUE	FALSE
phone-numbers-collaborators	TRUE	TRUE	FALSE
pictures	TRUE	TRUE	TRUE
plans	TRUE	TRUE	TRUE
posts	TRUE	FALSE	FALSE
posts-revisions	TRUE	FALSE	FALSE
public-account	TRUE	TRUE	TRUE
purchasable-phone-numbers	TRUE	FALSE	FALSE
result-metrics	TRUE	TRUE	FALSE
reviews	TRUE	TRUE	FALSE
reviews-comments	TRUE	TRUE	FALSE
saml-acs	TRUE	TRUE	TRUE
saml-metadata	TRUE	TRUE	TRUE
settings	TRUE	Read-only	TRUE
sso-authorize	TRUE	TRUE	TRUE
storage-metrics	TRUE	TRUE	FALSE
subscriptions	TRUE	FALSE	FALSE
tags	TRUE	TRUE	FALSE
teams	TRUE	TRUE	FALSE
teams-members	TRUE	TRUE	FALSE
terminals	TRUE	Read-only	FALSE
text-messages	TRUE	TRUE	FALSE
text-results	TRUE	TRUE	FALSE
text-templates	TRUE	TRUE	FALSE
text-templates-collaborators	TRUE	TRUE	FALSE
text-templates-revisions	TRUE	TRUE	FALSE
texts	TRUE	TRUE	FALSE
threads	TRUE	TRUE	FALSE
threads-contacts	TRUE	TRUE	FALSE
threads-items	TRUE	TRUE	FALSE
timezones	TRUE	TRUE	TRUE
tokens	TRUE	FALSE	FALSE
triggers	TRUE	TRUE	FALSE
uploads	TRUE	TRUE	FALSE
users	TRUE	TRUE	FALSE
users-addresses	TRUE	TRUE	FALSE
users-emails	TRUE	TRUE	FALSE
users-phones	TRUE	TRUE	FALSE
voice-templates	TRUE	TRUE	FALSE
voice-templates-collaborators	TRUE	TRUE	FALSE
voice-templates-revisions	TRUE	TRUE	FALSE

Collaborator Resources ¶

E.164 Phone Numbers ¶

Revision Resources ¶

Bulk Requests ¶

Deleting Multiple Resources ¶

Resources Supporting Meta ¶

Error Codes ¶

Authentication ¶

Token ¶

Create TokenPOST/oauth2/tokens

Example URI

Headers

Body

Body

Headers

Body

Body

Revoke ¶

Revoke TokenPOST/oauth2/revoke

Example URI

Headers

Body

User Resources ¶

Member ¶

Retrieve MemberGET/member

Example URI

Body

Update MemberPATCH/member

Example URI

Body

Body

User ¶

Retrieve UserGET/users/

Example URI

Body

User Address Collection ¶

Retrieve User AddressesGET/users/addresses{?include,filter,sort,page}

Example URI

Body

User Address ¶

Retrieve User AddressGET/users/addresses/

Example URI

Body

User Phone Collection ¶

Retrieve User PhonesGET/users/phones{?include,filter,sort,page}

Example URI

Body

User Phone ¶

Retrieve User PhoneGET/users/phones/

Example URI

Body

User Email Collection ¶

Retrieve User EmailsGET/users/emails{?include,filter,sort,page}

Example URI

Body

User Email ¶

Retrieve User EmailGET/users/emails/

Example URI

Body

Picture ¶

Retrieve PictureGET/pictures/

Example URI

Body

Token Collection ¶

Retrieve TokensGET/tokens{?include,filter,sort,page}

Example URI

Body

Create TokenPOST/tokens

Example URI

Body

Body

Token ¶

Retrieve TokenGET/tokens/

Example URI

Body

Update TokenPATCH/tokens/

Example URI

Body

Body

Delete TokenDELETE/tokens/

Collaborator Resources

E.164 Phone Numbers

Revision Resources

Bulk Requests

Deleting Multiple Resources

Resources Supporting Meta

Error Codes

Create Token
POST`/oauth2/tokens`

Revoke Token
POST`/oauth2/revoke`

Retrieve Member
GET`/member`

Update Member
PATCH`/member`

Retrieve User
GET`/users/`

Retrieve User Addresses
GET`/users/addresses{?include,filter,sort,page}`

Retrieve User Address
GET`/users/addresses/`

Retrieve User Phones
GET`/users/phones{?include,filter,sort,page}`

Retrieve User Phone
GET`/users/phones/`

Retrieve User Emails
GET`/users/emails{?include,filter,sort,page}`

Retrieve User Email
GET`/users/emails/`

Retrieve Picture
GET`/pictures/`

Retrieve Tokens
GET`/tokens{?include,filter,sort,page}`

Create Token
POST`/tokens`

Retrieve Token
GET`/tokens/`

Update Token
PATCH`/tokens/`

Delete Token
DELETE`/tokens/`

Retrieve Countries
GET`/countries{?include,filter,sort,page}`

Retrieve Country
GET`/countries/`

Retrieve Time Zones
GET`/timezones{?include,filter,sort,page}`

Retrieve Time Zone
GET`/timezones/`

Create an Upload
POST`/uploads`

Retrieve File
GET`/files/`

Delete File
DELETE`/files/`

Retrieve Engagements
GET`/engagements{?include,filter,sort,page}`

Create Engagement
POST`/engagements`

Retrieve Engagement
GET`/engagements/`

Update Engagement
PATCH`/engagements/`

Delete Engagement
DELETE`/engagements/`

Retrieve Engagement Collaborators
GET`/engagements/collaborators{?include,sort,filter,page}`

Create Engagement Collaborator
POST`/engagements/collaborators`

Retrieve Engagement Collaborator
GET`/engagements/collaborators/`

Update Engagement Collaborator
PATCH`/engagements/collaborators/`

Delete Engagement Collaborator
DELETE`/engagements/collaborators/`