Routes

Create a recipient route

Changed on

Binds a recipient pattern to a destination. Provide exactly one of endpoint_id (an existing endpoint) or function_id. With function_id, a dedicated route-target endpoint is minted for that function in the same transaction, enabling per-address function routing (e.g. alice@acme.com -> functionA).

post/routes

Request

  • Base URL: https://api.primitive.dev/v1
  • URL: https://api.primitive.dev/v1/routes
  • Auth: HTTP bearer

Request body

match_type'exact' | 'wildcard' | 'regex' required
patternstring required
endpoint_idstring uuid

An existing endpoint to route to. Mutually exclusive with function_id.

function_idstring uuid

Route to this function, minting its route-target endpoint if needed. Mutually exclusive with endpoint_id.

domain_idstring uuid nullable

Scope the route to a domain; defaults to the pattern's domain.

priorityinteger
enabledboolean

Response

Route created

successboolean required

Changes

  • 52138fa51360Revision changes
    • info

      removed the invalid_signup_code enum value from the / response property for the response status

    • info

      removed the invalid_signup_code enum value from the / response property for the response status

    • info

      removed the invalid_signup_code enum value from the / response property for the response status

    • info

      removed the invalid_signup_code enum value from the / response property for the response status

  • 22d1dfc68434Revision changes
    • warning

      added the new not_a_repeating_send enum value to the / response property for the response status

    • warning

      added the new not_a_repeating_send enum value to the / response property for the response status

    • warning

      added the new not_a_repeating_send enum value to the / response property for the response status

    • warning

      added the new not_a_repeating_send enum value to the / response property for the response status

    • warning

      added the new repeat_idle_requires_internal_recipient enum value to the / response property for the response status

    • warning

      added the new repeat_idle_requires_internal_recipient enum value to the / response property for the response status

    • warning

      added the new repeat_idle_requires_internal_recipient enum value to the / response property for the response status

    • warning

      added the new repeat_idle_requires_internal_recipient enum value to the / response property for the response status

    • warning

      added the new repeat_recipient_external enum value to the / response property for the response status

    • warning

      added the new repeat_recipient_external enum value to the / response property for the response status

    • warning

      added the new repeat_recipient_external enum value to the / response property for the response status

    • warning

      added the new repeat_recipient_external enum value to the / response property for the response status

    • warning

      added the new repeat_stop_not_allowed enum value to the / response property for the response status

    • warning

      added the new repeat_stop_not_allowed enum value to the / response property for the response status

    • warning

      added the new repeat_stop_not_allowed enum value to the / response property for the response status

    • warning

      added the new repeat_stop_not_allowed enum value to the / response property for the response status

    • warning

      added the new repeat_unsupported enum value to the / response property for the response status

    • warning

      added the new repeat_unsupported enum value to the / response property for the response status

    • warning

      added the new repeat_unsupported enum value to the / response property for the response status

    • warning

      added the new repeat_unsupported enum value to the / response property for the response status