Rivier/ Reference/ contacts

Change a map

put/crm/maps/{id}

Before you call

Credential
Authorization: Bearer $KEY
Scope
contacts:write
Graphql
Mutation.contactsMapUpdate
Sdk
contacts.map.update
Cli
contacts map update

Parameters

  • idstring (uuid)required
    In the path

Request bodyapplication/json, required

  • namestringrequired
    At most 120 characters.
  • titlestring
    At most 160 characters.
  • loadModestring
    One of: consent, click, always. Default: consent.
  • locationslist of objectrequired
    • idstringrequired
      Pattern: ^[a-z0-9][a-z0-9-]{0,40}$.
    • namestringrequired
      At most 160 characters.
    • addressstringrequired
      At most 300 characters.
    • latnumber
      At least -90. At most 90.
    • lngnumber
      At least -180. At most 180.
    • phonestring
      At most 40 characters.
    • urlstring (uri)
      At most 300 characters.
    • hoursstring
      At most 300 characters.
    • tagslist of string
  • defaultLanguagestring
    Default: en. Pattern: ^[a-z]{2}(-[A-Za-z]{2})?$.
  • labelsobject
  • designobject
    Default: {}.
    • themestring
      One of: auto, light, dark. Default: auto.
    • sizestring
      One of: compact, regular, large. Default: regular.
    • accentstring
      Pattern: ^#[0-9a-f]{6}$.
  • clusterboolean
    Default: true.
  • locatorboolean
    Default: true.
  • zoomnumber
    Default: 13. At least 1. At most 18.
  • allowedOriginslist of string

Responses

  • 200application/json
    Success

    object

  • 400application/json
    The request was malformed
    • errorstringrequired
    • messagestring
  • 401application/json
    No valid credential
    • errorstringrequired
    • messagestring
  • 403application/json
    The credential lacks the scope, origin or address
    • errorstringrequired
    • messagestring
  • 429application/json
    Over the key's rate limit; see Retry-After
    • errorstringrequired
    • messagestring

This page as Markdown