ITiterable
metadata

Create or replace metadata

Asynchronous. Creates or replaces the item associated with the specified key. 200 response indicates a valid request that will be processed; updates may not be made immediately. Use GET /api/metadata/{table}/{key} to verify completion.

put/api/metadata/{table}/{key}

Request

  • Base URL
    https://api.iterable.com
  • Auth
    API key in header Api-Key

Path parameters

tablestring required

Table name [Alphanumeric, case insensitive]

keystring required

Metadata key [Alphanumeric, case sensitive]

Request body

valueobject required

The JSON metadata value. Max size is is 30kb.

Response

successful operation

code'Success' | 'BadApiKey' | 'BadAuthorizationHeader' | 'BadJsonBody' | 'BadParams' | 'BatchTooLarge' | 'DatabaseError' | 'EmailAlreadyExists' | 'ExternalKeyConflict' | 'Forbidden' | 'ForbiddenParamsError' | 'ForgottenUserError' | 'GenericError' | 'InvalidEmailAddressError' | 'InvalidJwtPayload' | 'InvalidUserIdError' | 'JwtUserIdentifiersMismatched' | 'NotFound' | 'QueueEmailError' | 'RateLimitExceeded' | 'RequestFieldsTypesMismatched' | 'Unauthorized' | 'UniqueFieldsLimitExceeded' | 'UnknownEmailError' | 'UnknownUserIdError' | 'UserIdAlreadyExists' required
msgstring required

Response description

paramsobject

Additional info

Changes

No recorded changes to this operation across all 4 revisions of this API.