Skip to main content

Manage email API processes

Create Email ID

Preconditions

  • Brand must already exist
  • Brand has at least one (1) etag version whose resource state is PUBLISHED
  • Brand asset with PLACECARD_LOGO intent must already exist
  • At least one (1) etag version of a PLACECARD_LOGO is PUBLISHED

If any of these preconditions are not met, the brand and/or brand asset must be created first and you must wait until their respective resource states are PUBLISHED.

Process Description

  1. API user requests creation of an email ID resource.

  2. The service validates the description of the resource synchronously.

  3. If no inline validation with severity of VIOLATION is triggered, the resource state changes to PENDING_USER_ACTION.

  4. API user proceeds to create a DNS TXT record.

  5. After adding the TXT record to their DNS server, the API user proceeds to verify the domain.

  6. Resource state changes and notifications/feedback are generated in response to recorded events.

  7. API user polls for notifications every 15 minutes.

Flow Chart - Location Owner & Delegated Partner