Skip to content

Latest commit

 

History

History
47 lines (32 loc) · 2.2 KB

NewApplicationAPIKey.md

File metadata and controls

47 lines (32 loc) · 2.2 KB

NewApplicationAPIKey

Properties

Name Type Description Notes
title String Title of the API key.
expires OffsetDateTime The date the API key expires.
platform PlatformEnum The third-party platform the API key is valid for. Use `none` for a generic API key to be used from your own integration layer. [optional]
type TypeEnum The API key type. Can be empty or `staging`. Staging API keys can only be used for dry requests with the Update customer session endpoint, Update customer profile endpoint, and Track event endpoint. When using the Update customer profile endpoint with a staging API key, the query parameter `runRuleEngine` must be `true`. [optional]
timeOffset Integer A time offset in nanoseconds associated with the API key. When making a request using the API key, rule evaluation is based on a date that is calculated by adding the offset to the current date. [optional]
id Integer ID of the API Key.
createdBy Integer ID of user who created.
accountID Integer ID of account the key is used for.
applicationID Integer ID of application the key is used for.
created OffsetDateTime The date the API key was created.
key String The API key.

Enum: PlatformEnum

Name Value
NONE "none"
SEGMENT "segment"
BRAZE "braze"
MPARTICLE "mparticle"
SELLIGENT "selligent"
ITERABLE "iterable"
CUSTOMER_ENGAGEMENT "customer_engagement"
CUSTOMER_DATA "customer_data"
SALESFORCE "salesforce"
EMARSYS "emarsys"

Enum: TypeEnum

Name Value
STAGING "staging"