Rediger kontakt

API-URL

URL som brukes til å sende HTTP-forespørsler:

https://portal.bulkgate.com/api/1.0/address-book/edit

Merk

Hvis forespørselen ikke kommer frem, kan du sende den på nytt til reserveserveren backup1.bulkgate.com.

Støttede HTTP-metoder

POST - application/json

POST /api/1.0/address-book/edit HTTP/1.1 Host: portal.bulkgate.com Content-Type: application/json

Parametertabell

PARAMETERNAVN	VERDI	OBLIGATORISK	STANDARDVERDI
application_id	Application ID	Ja	-
application_token	Application token	Ja	-
phone_number	Telefonnummeret til kontakten som skal redigeres.	Ja	-
data	Kontaktinformasjon	Ja	Dataobjekt
category	Adresseboken det skal arbeides med. Standard er kontoens hovedadressebok.	Nei	`main`

Merk

Et felt som utelates, forblir uendret — skjemaet fyller inn -do-not-modify- for det. For å tømme et felt sender du en tom streng.

Dataobjekt

PARAMETERNAVN	VERDI	OBLIGATORISK	STANDARDVERDI
type	Person/firma	Nei	-
phone_mobile	Hovedtelefonnummer	Nei	-
title_before	Tittel foran navnet	Nei	-
first_name	Fornavn	Nei	-
last_name	Etternavn	Nei	-
title_after	Tittel etter navnet	Nei	-
gender	male / female / transgender / agender / non_binary / unknown	Nei	unknown
company_name	Firmaets navn	Nei	-
email	E-post	Nei	-
url	URL	Nei	-
street1	Gateadresse 1	Nei	-
street2	Gateadresse 2	Nei	-
city	By	Nei	-
zip	Postnummer	Nei	-
state	Delstat	Nei	-
country	Landskode i formatet ISO 3166-1 alpha-2.	Nei	`null`
company_number	Organisasjonsnummer	Nei	-
company_vat	MVA-nummer	Nei	-
note	Merknad	Nei	-
custom_field_0	Egendefinert felt	Nei	-
custom_field_1	Egendefinert felt	Nei	-
custom_field_2	Egendefinert felt	Nei	-
custom_field_3	Egendefinert felt	Nei	-
custom_field_4	Egendefinert felt	Nei	-
custom_field_5	Egendefinert felt	Nei	-
custom_field_6	Egendefinert felt	Nei	-
custom_field_7	Egendefinert felt	Nei	-
custom_field_8	Egendefinert felt	Nei	-
custom_field_9	Egendefinert felt	Nei	-

Eksempel på forespørsel

POST /api/1.0/address-book/edit HTTP/1.1 Host: portal.bulkgate.com Content-Type: application/json { "application_id": 451, "application_token": "NKN02TWE6NfBkfl-your-secret-token-Wf05GaqLIWLW4aBj", "phone_number": "123456789", "data": { "first_name": "Morgan", "last_name": "Yu", "phone_mobile": "123456789", "street1": "Crew's quarters", "street2": "Executive suite", "country": "Talos 1", "email": "morganyu@talos.com" } }

Svar

Ved suksess:

{ "data": { "message": "contact_has_been_edited" } }

Ved feil:

{ "type": "number_not_found", "code": 400, "error": "Number not found", "detail": null }

{ "type": "invalid_phone_number", "code": 400, "error": "Invalid phone number", "detail": null }

{ "type": "invalid_phone_mobile", "code": 400, "error": "Invalid phone mobile", "detail": null }

Der:

type og error (beskrivelse av feilen) finner du i tabellen over feiltyper
code er HTTP-feilkoden
detail er tilleggsinformasjon om feilen

Var denne siden nyttig?

Spør AI Kopiert