Starsender icon

Starsender

Interact with Starsender API

Contact → Create Contact

AI-generated

Summary

Create a new contact by providing their name, number, and optional variables.

Inputs

  • authHeaderName (required) — Select the header name for the API key (Authorization, X-API-KEY, or specify Other).
  • authHeaderCustom — Provide a custom header name if 'Other' is selected for Auth Header Name.
  • contactName (required) — Specify the name of the contact to be created.
  • contactNumber (required) — Provide the contact number for the new contact.
  • contactVariablesUi — Add key-value pairs for additional contact variables.
  • contactGroupId — Optionally assign the contact to a specific group by ID.

Output shape

a JSON object containing the created contact's details

The returned object may include details such as contact ID and status of the operation.

Examples

Example 1: Create a contact named 'John Doe' with the number '+1234567890'.

Set contactName to 'John Doe' and contactNumber to '+1234567890'.

Example 2: Create a contact with additional variables.

Set contactName to 'Jane Doe', contactNumber to '+0987654321', and add variables key-value pairs.

Discussion